From d01d94c1f9556276d420977cae8ab064a554d784 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Wed, 20 Feb 2019 03:15:59 +0800 Subject: [PATCH] improving consistency of azure examples/documentaion - 3 (#52573) * normalizing example naming conventions 3 * fixed line too long --- .../modules/cloud/azure/azure_rm_sqldatabase.py | 10 +++++----- .../modules/cloud/azure/azure_rm_sqlfirewallrule.py | 4 ++-- .../cloud/azure/azure_rm_sqlfirewallrule_facts.py | 6 +++--- .../modules/cloud/azure/azure_rm_sqlserver.py | 4 ++-- .../modules/cloud/azure/azure_rm_sqlserver_facts.py | 6 +++--- .../modules/cloud/azure/azure_rm_storageaccount.py | 6 +++--- .../cloud/azure/azure_rm_storageaccount_facts.py | 7 ++++--- .../modules/cloud/azure/azure_rm_storageblob.py | 6 +++--- lib/ansible/modules/cloud/azure/azure_rm_subnet.py | 8 ++++---- .../azure/azure_rm_trafficmanagerendpoint_facts.py | 8 ++++---- .../cloud/azure/azure_rm_trafficmanagerprofile.py | 4 ++-- .../azure/azure_rm_trafficmanagerprofile_facts.py | 8 +++++--- .../cloud/azure/azure_rm_virtualmachine_extension.py | 4 ++-- .../cloud/azure/azure_rm_virtualmachine_facts.py | 10 ++++++---- .../cloud/azure/azure_rm_virtualmachine_scaleset.py | 6 +++--- .../azure/azure_rm_virtualmachine_scaleset_facts.py | 10 +++++----- .../azure/azure_rm_virtualmachineextension_facts.py | 9 +++++---- .../azure_rm_virtualmachinescalesetextension.py | 6 +++--- ...azure_rm_virtualmachinescalesetextension_facts.py | 4 ++-- .../modules/cloud/azure/azure_rm_virtualnetwork.py | 4 ++-- .../cloud/azure/azure_rm_virtualnetwork_facts.py | 6 +++--- .../cloud/azure/azure_rm_virtualnetworkpeering.py | 6 +++--- .../modules/cloud/azure/azure_rm_webapp_facts.py | 9 +++++---- .../modules/cloud/azure/azure_rm_webappslot.py | 12 ++++++------ 24 files changed, 85 insertions(+), 78 deletions(-) diff --git a/lib/ansible/modules/cloud/azure/azure_rm_sqldatabase.py b/lib/ansible/modules/cloud/azure/azure_rm_sqldatabase.py index a5da6247259..3802c5c5fb3 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_sqldatabase.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_sqldatabase.py @@ -144,14 +144,14 @@ author: EXAMPLES = ''' - name: Create (or update) SQL Database azure_rm_sqldatabase: - resource_group: sqlcrudtest-4799 + resource_group: myResourceGroup server_name: sqlcrudtest-5961 name: testdb location: eastus - name: Restore SQL Database azure_rm_sqldatabase: - resource_group: sqlcrudtest-4799 + resource_group: myResourceGroup server_name: sqlcrudtest-5961 name: restoreddb location: eastus @@ -161,12 +161,12 @@ EXAMPLES = ''' - name: Create SQL Database in Copy Mode azure_rm_sqldatabase: - resource_group: sqlcrudtest-4799 + resource_group: myResourceGroup server_name: sqlcrudtest-5961 name: copydb location: eastus create_mode: copy - source_database_id: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/tests + source_database_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/tests vr/databases/testdb" ''' @@ -177,7 +177,7 @@ id: - Resource ID. returned: always type: str - sample: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb" database_id: description: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule.py b/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule.py index 8c0bd1a1ee7..d999ccf9420 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule.py @@ -60,7 +60,7 @@ author: EXAMPLES = ''' - name: Create (or update) Firewall Rule azure_rm_sqlfirewallrule: - resource_group: firewallrulecrudtest-12 + resource_group: myResourceGroup server_name: firewallrulecrudtest-6285 name: firewallrulecrudtest-5370 start_ip_address: 172.28.10.136 @@ -73,7 +73,7 @@ id: - Resource ID. returned: always type: str - sample: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/firewallrulecrudtest-12/providers/Microsoft.Sql/servers/firewallrulecrudtest-628 + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/firewallrulecrudtest-628 5/firewallRules/firewallrulecrudtest-5370" ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule_facts.py index b67fdf13122..3db08398178 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule_facts.py @@ -45,13 +45,13 @@ author: EXAMPLES = ''' - name: Get instance of SQL Firewall Rule azure_rm_sqlfirewallrule_facts: - resource_group: testgroup + resource_group: myResourceGroup server_name: testserver name: testrule - name: List instances of SQL Firewall Rule azure_rm_sqlfirewallrule_facts: - resource_group: testgroup + resource_group: myResourceGroup server_name: testserver ''' @@ -66,7 +66,7 @@ rules: - Resource ID returned: always type: str - sample: "/subscriptions/xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testgroup/providers/Microsoft.Sql/servers/testser + sample: "/subscriptions/xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/testser ver/firewallRules/testrule" resource_group: description: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py b/lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py index 634241bf347..35026f84b31 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py @@ -67,7 +67,7 @@ author: EXAMPLES = ''' - name: Create (or update) SQL Server azure_rm_sqlserver: - resource_group: resource_group + resource_group: myResourceGroup name: server_name location: westus admin_username: mylogin @@ -80,7 +80,7 @@ id: - Resource ID. returned: always type: str - sample: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645 + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645 version: description: - The version of the server. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_sqlserver_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_sqlserver_facts.py index 962fe945648..e9f9bfb3974 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_sqlserver_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_sqlserver_facts.py @@ -42,12 +42,12 @@ author: EXAMPLES = ''' - name: Get instance of SQL Server azure_rm_sqlserver_facts: - resource_group: resource_group_name + resource_group: myResourceGroup server_name: server_name - name: List instances of SQL Server azure_rm_sqlserver_facts: - resource_group: resource_group_name + resource_group: myResourceGroup ''' RETURN = ''' @@ -65,7 +65,7 @@ servers: - Resource ID. returned: always type: str - sample: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645 + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645 name: description: - Resource name. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py index 9ab8d45fc11..4e79bb97289 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py @@ -139,13 +139,13 @@ author: EXAMPLES = ''' - name: remove account, if it exists azure_rm_storageaccount: - resource_group: Testing + resource_group: myResourceGroup name: clh0002 state: absent - name: create an account azure_rm_storageaccount: - resource_group: Testing + resource_group: myResourceGroup name: clh0002 type: Standard_RAGRS tags: @@ -154,7 +154,7 @@ EXAMPLES = ''' - name: create an account with blob CORS azure_rm_storageaccount: - resource_group: Testing + resource_group: myResourceGroup name: clh002 type: Standard_RAGRS blob_cors: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount_facts.py index 38e3500c911..941bbf33dd8 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount_facts.py @@ -62,12 +62,12 @@ author: EXAMPLES = ''' - name: Get facts for one account azure_rm_storageaccount_facts: - resource_group: Testing + resource_group: myResourceGroup name: clh0002 - name: Get facts for all accounts in a resource group azure_rm_storageaccount_facts: - resource_group: Testing + resource_group: myResourceGroup - name: Get facts for all accounts by tags azure_rm_storageaccount_facts: @@ -109,7 +109,8 @@ storageaccounts: id: description: - Resource ID. - sample: "/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/testing/providers/Microsoft.Storage/storageAccounts/testaccount001" + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/t + estaccount001" name: description: - Name of the storage account to update or create. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py b/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py index 302b73240a7..5e940ca1ac8 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py @@ -125,14 +125,14 @@ author: EXAMPLES = ''' - name: Remove container foo azure_rm_storageblob: - resource_group: testing + resource_group: myResourceGroup storage_account_name: clh0002 container: foo state: absent - name: Create container foo and upload a file azure_rm_storageblob: - resource_group: Testing + resource_group: myResourceGroup storage_account_name: clh0002 container: foo blob: graylog.png @@ -142,7 +142,7 @@ EXAMPLES = ''' - name: Download the file azure_rm_storageblob: - resource_group: Testing + resource_group: myResourceGroup storage_account_name: clh0002 container: foo blob: graylog.png diff --git a/lib/ansible/modules/cloud/azure/azure_rm_subnet.py b/lib/ansible/modules/cloud/azure/azure_rm_subnet.py index 9a692002c2b..75d23f12780 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_subnet.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_subnet.py @@ -98,25 +98,25 @@ EXAMPLES = ''' azure_rm_subnet: name: foobar virtual_network_name: My_Virtual_Network - resource_group: Testing + resource_group: myResourceGroup address_prefix_cidr: "10.1.0.0/24" - name: Create a subnet refer nsg from other resource group azure_rm_subnet: name: foobar virtual_network_name: My_Virtual_Network - resource_group: Testing + resource_group: myResourceGroup address_prefix_cidr: "10.1.0.0/16" security_group: name: secgroupfoo - resource_group: Testing1 + resource_group: mySecondResourceGroup route_table: route - name: Delete a subnet azure_rm_subnet: name: foobar virtual_network_name: My_Virtual_Network - resource_group: Testing + resource_group: myResourceGroup state: absent ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerendpoint_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerendpoint_facts.py index 0c2be1bc9d8..3196f336977 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerendpoint_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerendpoint_facts.py @@ -54,12 +54,12 @@ author: EXAMPLES = ''' - name: Get endpoints facts of a Traffic Manager profile azure_rm_trafficmanagerendpoint_facts: - resource_group: TestRG + resource_group: myResourceGroup profile_name: Testing - name: Get specific endpoint of a Traffic Manager profile azure_rm_trafficmanager_facts: - resource_group: TestRG + resource_group: myResourceGroup profile_name: Testing name: test_external_endpoint @@ -76,7 +76,7 @@ endpoints: - Name of a resource group. returned: always type: str - sample: testGroup + sample: myResourceGroup name: description: - Name of the Traffic Manager endpoint. @@ -92,7 +92,7 @@ endpoints: description: - The Azure Resource URI of the of the endpoint. type: str - sample: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/vscjavaci/providers/Microsoft.ClassicCompute/domainNames/vscjavaci + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/vscjavaci target: description: - The fully-qualified DNS name of the endpoint. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile.py b/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile.py index 8750e6339c9..8a5069d6575 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile.py @@ -113,7 +113,7 @@ EXAMPLES = ''' - name: Create a Traffic Manager Profile azure_rm_trafficmanagerprofile: name: tmtest - resource_group: tmt + resource_group: myResourceGroup location: global profile_status: enabled routing_method: priority @@ -131,7 +131,7 @@ EXAMPLES = ''' azure_rm_trafficmanagerprofile: state: absent name: tmtest - resource_group: tmt + resource_group: myResourceGroup ''' RETURN = ''' id: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile_facts.py index 2173c948731..7c581d7d3ad 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_trafficmanagerprofile_facts.py @@ -46,7 +46,7 @@ EXAMPLES = ''' - name: Get facts for one Traffic Manager profile azure_rm_trafficmanager_facts: name: Testing - resource_group: TestRG + resource_group: myResourceGroup - name: Get facts for all Traffic Manager profiles azure_rm_trafficmanager_facts: @@ -148,7 +148,8 @@ tms: description: - Fully qualified resource Id for the resource. type: str - sample: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1 + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan + agerProfiles/tmtest/externalEndpoints/e1" name: description: - The name of the endpoint. @@ -163,7 +164,8 @@ tms: description: - The Azure Resource URI of the of the endpoint. type: str - sample: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/vscjavaci/providers/Microsoft.ClassicCompute/domainNames/vscjavaci + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom + ainNames/vscjavaci" target: description: - The fully-qualified DNS name of the endpoint. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_extension.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_extension.py index 0736ea23e04..ae72409ca47 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_extension.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_extension.py @@ -80,7 +80,7 @@ EXAMPLES = ''' azure_rm_virtualmachine_extension: name: myvmextension location: eastus - resource_group: Testing + resource_group: myResourceGroup virtual_machine_name: myvm publisher: Microsoft.Azure.Extensions virtual_machine_extension_type: CustomScript @@ -92,7 +92,7 @@ EXAMPLES = ''' azure_rm_virtualmachine_extension: name: myvmextension location: eastus - resource_group: Testing + resource_group: myResourceGroup virtual_machine_name: myvm state: absent ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_facts.py index 37dd0064455..268584847f5 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_facts.py @@ -49,16 +49,16 @@ author: EXAMPLES = ''' - name: Get facts for all virtual machines of a resource group azure_rm_virtualmachine_facts: - resource_group: Testing + resource_group: myResourceGroup - name: Get facts by name azure_rm_virtualmachine_facts: - resource_group: Testing + resource_group: myResourceGroup name: vm - name: Get facts by tags azure_rm_virtualmachine_facts: - resource_group: Testing + resource_group: myResourceGroup tags: - testing - foo:bar @@ -107,7 +107,8 @@ vms: - Resource ID. returned: always type: str - sample: /subscriptions/xxxx/resourceGroups/myclusterrg/providers/Microsoft.Compute/virtualMachines/mycluster-node-2 + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/my + cluster-node-2" image: description: - Image specification @@ -167,6 +168,7 @@ vms: description: - Resource group. type: str + sample: myResourceGroup state: description: - State of the resource. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py index a422314c2d1..9624d945c88 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py @@ -227,7 +227,7 @@ EXAMPLES = ''' - name: Create VMSS azure_rm_virtualmachine_scaleset: - resource_group: Testing + resource_group: myResourceGroup name: testvmss vm_size: Standard_DS1_v2 capacity: 2 @@ -252,7 +252,7 @@ EXAMPLES = ''' - name: Create a VMSS with a custom image azure_rm_virtualmachine_scaleset: - resource_group: Testing + resource_group: myResourceGroup name: testvmss vm_size: Standard_DS1_v2 capacity: 2 @@ -265,7 +265,7 @@ EXAMPLES = ''' - name: Create a VMSS with a custom image from a particular resource group azure_rm_virtualmachine_scaleset: - resource_group: Testing + resource_group: myResourceGroup name: testvmss vm_size: Standard_DS1_v2 capacity: 2 diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset_facts.py index 504e8acbe28..766ba12e880 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset_facts.py @@ -55,17 +55,17 @@ author: EXAMPLES = ''' - name: Get facts for a virtual machine scale set azure_rm_virtualmachine_scaleset_facts: - resource_group: Testing + resource_group: myResourceGroup name: testvmss001 format: curated - name: Get facts for all virtual networks azure_rm_virtualmachine_scaleset_facts: - resource_group: Testing + resource_group: myResourceGroup - name: Get facts by tags azure_rm_virtualmachine_scaleset_facts: - resource_group: Testing + resource_group: myResourceGroup tags: - testing ''' @@ -81,7 +81,7 @@ vmss: - Resource ID returned: always type: str - sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.Compute/scalesets/myscaleset + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset admin_username: description: - Admin username used to access the host after it is created. @@ -192,7 +192,7 @@ vmss: - Resource group. type: str returned: always - sample: testrg + sample: myResourceGroup ssh_password_enabled: description: - Is SSH password authentication enabled. Valid only for Linux. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachineextension_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachineextension_facts.py index 917c99685c3..c6e3e40679c 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachineextension_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachineextension_facts.py @@ -48,13 +48,13 @@ author: EXAMPLES = ''' - name: Get information on specific Virtual Machine Extension azure_rm_virtualmachineextension_facts: - resource_group: myrg + resource_group: myResourceGroup virtual_machine_name: myvm name: myextension - name: List installed Virtual Machine Extensions azure_rm_virtualmachineextension_facts: - resource_group: myrg + resource_group: myResourceGroup virtual_machine_name: myvm ''' @@ -69,13 +69,14 @@ extensions: - Resource Id returned: always type: str - sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.Compute/myvm/testVM/extensions/myextension + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myvm/testVM/extens + ions/myextension" resource_group: description: - Resource group name returned: always type: str - sample: myrg + sample: myResourceGroup virtual_machine_name: description: - Virtual machine name diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetextension.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetextension.py index 3b46c7f70ea..b01078ace7a 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetextension.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetextension.py @@ -84,7 +84,7 @@ EXAMPLES = ''' azure_rm_virtualmachinescalesetextension: name: myvmssextension location: eastus - resource_group: Testing + resource_group: myResourceGroup vmss_name: myvm publisher: Microsoft.Azure.Extensions type: CustomScript @@ -96,7 +96,7 @@ EXAMPLES = ''' azure_rm_virtualmachinescalesetextension: name: myvmssextension location: eastus - resource_group: Testing + resource_group: myResourceGroup vmss_name: myvm state: absent ''' @@ -107,7 +107,7 @@ id: - VMSS extension resource ID returned: always type: str - sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.Compute/scalesets/myscaleset/extensions/myext + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset/extensions/myext ''' from ansible.module_utils.azure_rm_common import AzureRMModuleBase diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetextension_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetextension_facts.py index fc6dc9ec169..957e1ea664a 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetextension_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetextension_facts.py @@ -45,7 +45,7 @@ author: EXAMPLES = ''' - name: Get information on specific Virtual Machine Scale Set Extension azure_rm_virtualmachineextension_facts: - resource_group: myrg + resource_group: myResourceGroup vmss_name: myvmss name: myextension @@ -66,7 +66,7 @@ extensions: - Resource Id returned: always type: str - sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachineScaleSets/ + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/ myvmss/extensions/myextension" resource_group: description: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py index b30f05b624e..61c3732d02e 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py @@ -82,7 +82,7 @@ EXAMPLES = ''' - name: Create a virtual network azure_rm_virtualnetwork: name: foobar - resource_group: Testing + resource_group: myResourceGroup address_prefixes_cidr: - "10.1.0.0/16" - "172.100.0.0/16" @@ -96,7 +96,7 @@ EXAMPLES = ''' - name: Delete a virtual network azure_rm_virtualnetwork: name: foobar - resource_group: Testing + resource_group: myResourceGroup state: absent ''' RETURN = ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py index 40c411a45e1..60ab8123789 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py @@ -48,12 +48,12 @@ author: EXAMPLES = ''' - name: Get facts for one virtual network azure_rm_virtualnetwork_facts: - resource_group: Testing + resource_group: myResourceGroup name: secgroup001 - name: Get facts for all virtual networks azure_rm_virtualnetwork_facts: - resource_group: Testing + resource_group: myResourceGroup - name: Get facts by tags azure_rm_virtualnetwork_facts: @@ -90,7 +90,7 @@ virtualnetworks: id: description: - Resource ID. - sample: /subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/virtualNetworks/vnet2001 + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet2001 type: str address_prefixes: description: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkpeering.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkpeering.py index 98105d6f828..651508cea2e 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkpeering.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkpeering.py @@ -80,18 +80,18 @@ author: EXAMPLES = ''' - name: Create virtual network peering azure_rm_virtualnetworkpeering: - resource_group: myResourceGroup1 + resource_group: myResourceGroup name: vnet_peer1 virtual_network: myVnet1 remote_virtual_network: - resource_group: myResourceGroup2 + resource_group: mySecondResourceGroup name: myVnet2 allow_virtual_network_access: false allow_forwarded_traffic: true - name: Delete the virtual network peering azure_rm_virtualnetworkpeering: - resource_group: myResourceGroup1 + resource_group: myResourceGroup name: vnet_peer1 virtual_network: myVnet1 state: absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_webapp_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_webapp_facts.py index c1ac0ff9909..bff57627a34 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_webapp_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_webapp_facts.py @@ -50,12 +50,12 @@ author: EXAMPLES = ''' - name: Get facts for web app by name azure_rm_webapp_facts: - resource_group: testrg + resource_group: myResourceGroup name: winwebapp1 - name: Get facts for web apps in resource group azure_rm_webapp_facts: - resource_group: testrg + resource_group: myResourceGroup - name: Get facts for web apps with tags azure_rm_webapp_facts: @@ -75,7 +75,7 @@ webapps: - Id of the web app. returned: always type: str - sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/sites/xx + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/xx name: description: - Name of the web app. @@ -86,6 +86,7 @@ webapps: - Resource group of the web app. returned: always type: str + sample: myResourceGroup location: description: - Location of the web app. @@ -96,7 +97,7 @@ webapps: - Id of app service plan used by the web app. returned: always type: str - sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/serverfarms/xxx + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/xxx app_settings: description: - App settings of the application. Only returned when web app has app settings. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py b/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py index 3fce3b8b262..1ddf15b82ed 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py @@ -171,7 +171,7 @@ author: EXAMPLES = ''' - name: Create a webapp slot azure_rm_webapp_slot: - resource_group: myRG + resource_group: myResourceGroup webapp_name: myJavaWebApp name: stage configuration_source: myJavaWebApp @@ -180,7 +180,7 @@ EXAMPLES = ''' - name: swap the slot with production slot azure_rm_webapp_slot: - resource_group: myRG + resource_group: myResourceGroup webapp_name: myJavaWebApp name: stage swap: @@ -188,14 +188,14 @@ EXAMPLES = ''' - name: stop the slot azure_rm_webapp_slot: - resource_group: myRG + resource_group: myResourceGroup webapp_name: myJavaWebApp name: stage app_state: stopped - name: udpate a webapp slot app settings azure_rm_webapp_slot: - resource_group: myRG + resource_group: myResourceGroup webapp_name: myJavaWebApp name: stage app_settings: @@ -203,7 +203,7 @@ EXAMPLES = ''' - name: udpate a webapp slot frameworks azure_rm_webapp_slot: - resource_group: myRG + resource_group: myResourceGroup webapp_name: myJavaWebApp name: stage frameworks: @@ -216,7 +216,7 @@ id: description: Id of current slot. returned: always type: str - sample: /subscriptions//resourceGroups/myRG/providers/Microsoft.Web/sites/testapp/slots/stage1 + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/testapp/slots/stage1 ''' import time