improving consistency of azure examples/documentation - 2 (#52572)

* normalizing azure example naming conventions - 2
This commit is contained in:
Zim Kalinowski 2019-02-20 21:39:41 +08:00 committed by Alicia Cozine
parent 220d0cb16b
commit 9b5514928a
33 changed files with 91 additions and 87 deletions

View file

@ -64,13 +64,13 @@ author:
EXAMPLES = '''
- name: create function app
azure_rm_functionapp:
resource_group: ansible-rg
resource_group: myResourceGroup
name: myfunctionapp
storage_account: mystorageaccount
- name: create a function app with app settings
azure_rm_functionapp:
resource_group: ansible-rg
resource_group: myResourceGroup
name: myfunctionapp
storage_account: mystorageaccount
app_settings:
@ -121,7 +121,7 @@ state:
outbound_ip_addresses: ............
container_size: 1536
daily_memory_time_quota: 0
resource_group: ansible-rg
resource_group: myResourceGroup
default_host_name: myfunctionapp.azurewebsites.net
''' # NOQA

View file

@ -43,12 +43,12 @@ author:
EXAMPLES = '''
- name: Get facts for one Function App
azure_rm_functionapp_facts:
resource_group: ansible-rg
resource_group: myResourceGroup
name: myfunctionapp
- name: Get facts for all Function Apps in a resource group
azure_rm_functionapp_facts:
resource_group: ansible-rg
resource_group: myResourceGroup
- name: Get facts for all Function Apps by tags
azure_rm_functionapp_facts:
@ -94,7 +94,7 @@ azure_functionapps:
outbound_ip_addresses: ............
container_size: 1536
daily_memory_time_quota: 0
resource_group: ansible-rg
resource_group: myResourceGroup
default_host_name: myfunctionapp.azurewebsites.net
'''

View file

@ -70,13 +70,13 @@ author:
EXAMPLES = '''
- name: Create an image from a virtual machine
azure_rm_image:
resource_group: Testing
resource_group: myResourceGroup
name: foobar
source: testvm001
- name: Create an image from os disk
azure_rm_image:
resource_group: Testing
resource_group: myResourceGroup
name: foobar
source: /subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Compute/disks/disk001
data_disk_sources:
@ -86,11 +86,11 @@ EXAMPLES = '''
- name: Create an image from os disk via dict
azure_rm_image:
resource_group: Testing
resource_group: myResourceGroup
name: foobar
source:
type: disks
resource_group: Testing
resource_group: myResourceGroup
name: disk001
data_disk_sources:
- datadisk001
@ -100,7 +100,7 @@ EXAMPLES = '''
- name: Delete an image
azure_rm_image:
state: absent
resource_group: Testing
resource_group: myResourceGroup
name: foobar
source: testvm001
'''

View file

@ -44,11 +44,11 @@ EXAMPLES = '''
- name: List images with name
azure_rm_image_facts:
name: test-image
resource_group: test-resource-group
resource_group: myResourceGroup
- name: List images by resource group
azure_rm_image_facts:
resource_group: test-resource-group
resource_group: myResourceGroup
tags:
- testing
- foo:bar
@ -69,7 +69,7 @@ images:
- Id of the image.
returned: always
type: str
sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Compute/images/xx
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/xx
name:
description:
- Name of the image.
@ -80,6 +80,7 @@ images:
- Resource group of the image.
returned: always
type: str
sample: myResourceGroup
location:
description:
- Location of the image.
@ -89,7 +90,7 @@ images:
description:
- Id of os disk for image.
type: str
sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Compute/disks/xx
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/xx
os_disk_caching:
description:
- Specifies caching requirements for the image.
@ -122,7 +123,7 @@ images:
description:
- Resource id of source VM from which the image is created
type: str
sample: /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Compute/virtualMachines/xx
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/xx
tags:
description:
- Dictionary of tags associated with the image.
@ -158,7 +159,7 @@ images:
description:
- Id of managed disk.
type: str
sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Compute/disks/xx
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/xx
blob_uri:
description:
- The virtual hard disk.

View file

@ -161,7 +161,7 @@ author:
EXAMPLES = '''
- name: Create instance of Key Vault
azure_rm_keyvault:
resource_group: myresourcegroup
resource_group: myResourceGroup
vault_name: samplekeyvault
enabled_for_deployment: yes
vault_tenant: 72f98888-8666-4144-9199-2d7cd0111111

View file

@ -295,7 +295,7 @@ author:
EXAMPLES = '''
- name: create load balancer
azure_rm_loadbalancer:
resource_group: testrg
resource_group: myResourceGroup
name: testloadbalancer1
frontend_ip_configurations:
- name: frontendipconf0

View file

@ -46,14 +46,14 @@ EXAMPLES = '''
- name: Get facts for one load balancer
azure_rm_loadbalancer_facts:
name: Testing
resource_group: TestRG
resource_group: myResourceGroup
- name: Get facts for all load balancers
azure_rm_loadbalancer_facts:
- name: Get facts for all load balancers in a specific resource group
azure_rm_loadbalancer_facts:
resource_group: TestRG
resource_group: myResourceGroup
- name: Get facts by tags
azure_rm_loadbalancer_facts:

View file

@ -98,14 +98,14 @@ EXAMPLES = '''
azure_rm_managed_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
resource_group: myResourceGroup
disk_size_gb: 4
- name: Create managed operating system disk from page blob
azure_rm_managed_disk:
name: mymanageddisk
location: eastus2
resource_group: Testing
resource_group: myResourceGroup
create_option: import
source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
os_type: windows
@ -115,7 +115,7 @@ EXAMPLES = '''
azure_rm_managed_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
resource_group: myResourceGroup
disk_size_gb: 4
managed_by: testvm001
@ -123,14 +123,14 @@ EXAMPLES = '''
azure_rm_managed_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
resource_group: myResourceGroup
disk_size_gb: 4
- name: Delete managed disk
azure_rm_manage_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
resource_group: myResourceGroup
state: absent
'''

View file

@ -50,7 +50,7 @@ EXAMPLES = r'''
- name: Get facts for one managed disk
azure_rm_managed_disk_facts:
name: Testing
resource_group: TestRG
resource_group: myResourceGroup
- name: Get facts for all managed disks
azure_rm_managed_disk_facts:

View file

@ -45,13 +45,13 @@ author:
EXAMPLES = '''
- name: Get specific setting of MySQL Server
azure_rm_mysqlconfiguration_facts:
resource_group: testrg
resource_group: myResourceGroup
server_name: testmysqlserver
name: deadlock_timeout
- name: Get all settings of MySQL Server
azure_rm_mysqlconfiguration_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
server_name: server_name
'''
@ -66,7 +66,7 @@ settings:
- Setting resource ID
returned: always
type: str
sample: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/servers/testmysqlser
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/testmysqlser
ver/configurations/deadlock_timeout"
name:
description:

View file

@ -71,7 +71,7 @@ author:
EXAMPLES = '''
- name: Create (or update) MySQL Database
azure_rm_mysqldatabase:
resource_group: TestGroup
resource_group: myResourceGroup
server_name: testserver
name: db1
'''
@ -82,7 +82,7 @@ id:
- Resource ID
returned: always
type: str
sample: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/databases/db1
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/testserver/databases/db1
name:
description:
- Resource name.

View file

@ -45,13 +45,13 @@ author:
EXAMPLES = '''
- name: Get instance of MySQL Database
azure_rm_mysqldatabase_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
server_name: server_name
name: database_name
- name: List instances of MySQL Database
azure_rm_mysqldatabase_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
server_name: server_name
'''
@ -66,7 +66,7 @@ databases:
- Resource ID
returned: always
type: str
sample: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testser
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/testser
ver/databases/db1"
resource_group:
description:

View file

@ -59,7 +59,7 @@ author:
EXAMPLES = '''
- name: Create (or update) MySQL firewall rule
azure_rm_mysqlfirewallrule:
resource_group: TestGroup
resource_group: myResourceGroup
server_name: testserver
name: rule1
start_ip_address: 10.0.0.17
@ -72,7 +72,8 @@ id:
- Resource ID
returned: always
type: str
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/firewallRules/rule1
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/testserver/fire
wallRules/rule1"
'''
import time

View file

@ -45,13 +45,13 @@ author:
EXAMPLES = '''
- name: Get instance of MySQL Firewall Rule
azure_rm_mysqlfirewallrule_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
server_name: server_name
name: firewall_rule_name
- name: List instances of MySQL Firewall Rule
azure_rm_mysqlfirewallrule_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
server_name: server_name
'''

View file

@ -92,7 +92,7 @@ author:
EXAMPLES = '''
- name: Create (or update) MySQL Server
azure_rm_mysqlserver:
resource_group: TestGroup
resource_group: myResourceGroup
name: testserver
sku:
name: B_Gen5_1
@ -111,7 +111,7 @@ id:
- Resource ID
returned: always
type: str
sample: /subscriptions/12345678-1234-1234-1234-123412341234/testrg/providers/Microsoft.DBforMySQL/servers/mysqlsrv1b6dd89593
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/mysqlsrv1b6dd89593
version:
description:
- 'Server version. Possible values include: C(5.6), C(5.7)'

View file

@ -44,12 +44,12 @@ author:
EXAMPLES = '''
- name: Get instance of MySQL Server
azure_rm_mysqlserver_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
name: server_name
- name: List instances of MySQL Server
azure_rm_mysqlserver_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
'''
RETURN = '''
@ -63,13 +63,13 @@ servers:
- Resource ID
returned: always
type: str
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/myabdud1223
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/myabdud1223
resource_group:
description:
- Resource group name.
returned: always
type: str
sample: testresourcegroup
sample: myResourceGroup
name:
description:
- Resource name.

View file

@ -48,16 +48,16 @@ author:
EXAMPLES = '''
- name: Get facts for one network interface
azure_rm_networkinterface_facts:
resource_group: Testing
resource_group: myResourceGroup
name: nic001
- name: Get network interfaces within a resource group
azure_rm_networkinterface_facts:
resource_group: Testing
resource_group: myResourceGroup
- name: Get network interfaces by tag
azure_rm_networkinterface_facts:
resource_group: Testing
resource_group: myResourceGroup
tags:
- testing
- foo:bar

View file

@ -45,13 +45,13 @@ author:
EXAMPLES = '''
- name: Get specific setting of PostgreSQL configuration
azure_rm_postgresqlconfiguration_facts:
resource_group: testrg
resource_group: myResourceGroup
server_name: testpostgresqlserver
name: deadlock_timeout
- name: Get all settings of PostgreSQL Configuration
azure_rm_postgresqlconfiguration_facts:
resource_group: testrg
resource_group: myResourceGroup
server_name: testpostgresqlserver
'''

View file

@ -71,7 +71,7 @@ author:
EXAMPLES = '''
- name: Create (or update) PostgreSQL Database
azure_rm_postgresqldatabase:
resource_group: TestGroup
resource_group: myResourceGroup
server_name: testserver
name: db1
'''
@ -82,7 +82,8 @@ id:
- Resource ID
returned: always
type: str
sample: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/databases/db1
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroups/providers/Microsoft.DBforPostgreSQL/servers/testserve
r/databases/db1"
name:
description:
- Resource name.

View file

@ -45,13 +45,13 @@ author:
EXAMPLES = '''
- name: Get instance of PostgreSQL Database
azure_rm_postgresqldatabase_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
server_name: server_name
name: database_name
- name: List instances of PostgreSQL Database
azure_rm_postgresqldatabase_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
server_name: server_name
'''
@ -66,7 +66,7 @@ databases:
- Resource ID
returned: always
type: str
sample: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testser
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/testser
ver/databases/db1"
resource_group:
description:

View file

@ -59,7 +59,7 @@ author:
EXAMPLES = '''
- name: Create (or update) PostgreSQL firewall rule
azure_rm_postgresqlfirewallrule:
resource_group: TestGroup
resource_group: myResourceGroup
server_name: testserver
name: rule1
start_ip_address: 10.0.0.16
@ -72,8 +72,8 @@ id:
- Resource ID
returned: always
type: str
sample: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRule
s/rule1"
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver
/firewallRules/rule1"
'''
import time

View file

@ -45,13 +45,13 @@ author:
EXAMPLES = '''
- name: Get instance of PostgreSQL Firewall Rule
azure_rm_postgresqlfirewallrule_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
server_name: server_name
name: firewall_rule_name
- name: List instances of PostgreSQL Firewall Rule
azure_rm_postgresqlfirewallrule_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
server_name: server_name
'''

View file

@ -92,7 +92,7 @@ author:
EXAMPLES = '''
- name: Create (or update) PostgreSQL Server
azure_rm_postgresqlserver:
resource_group: TestGroup
resource_group: myResourceGroup
name: testserver
sku:
name: B_Gen5_1
@ -110,7 +110,7 @@ id:
- Resource ID
returned: always
type: str
sample: /subscriptions/12345678-1234-1234-1234-123412341234/resourceGroups/samplerg/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593
version:
description:
- 'Server version. Possible values include: C(9.5), C(9.6), C(10)'

View file

@ -44,12 +44,12 @@ author:
EXAMPLES = '''
- name: Get instance of PostgreSQL Server
azure_rm_postgresqlserver_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
name: server_name
- name: List instances of PostgreSQL Server
azure_rm_postgresqlserver_facts:
resource_group: resource_group_name
resource_group: myResourceGroup
'''
RETURN = '''
@ -63,13 +63,14 @@ servers:
- Resource ID
returned: always
type: str
sample: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/postgreabdud1223
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/po
stgreabdud1223"
resource_group:
description:
- Resource group name.
returned: always
type: str
sample: testresourcegroup
sample: myResourceGroup
name:
description:
- Resource name.

View file

@ -102,14 +102,14 @@ author:
EXAMPLES = '''
- name: Create a public ip address
azure_rm_publicipaddress:
resource_group: testing
resource_group: myResourceGroup
name: my_public_ip
allocation_method: static
domain_name: foobar
- name: Delete public ip
azure_rm_publicipaddress:
resource_group: testing
resource_group: myResourceGroup
name: my_public_ip
state: absent
'''

View file

@ -47,12 +47,12 @@ author:
EXAMPLES = '''
- name: Get facts for one Public IP
azure_rm_publicipaddress_facts:
resource_group: Testing
resource_group: myResourceGroup
name: publicip001
- name: Get facts for all Public IPs within a resource groups
azure_rm_publicipaddress_facts:
resource_group: Testing
resource_group: myResourceGroup
'''
RETURN = '''

View file

@ -109,12 +109,12 @@ author:
EXAMPLES = '''
- name: Update scaleset info using azure_rm_resource
azure_rm_resource:
resource_group: "{{ resource_group }}"
resource_group: myResourceGroup
provider: compute
resource_type: virtualmachinescalesets
resource_name: "{{ scaleset_name }}"
resource_name: myVmss
api_version: "2017-12-01"
body: "{{ body }}"
body: { body }
'''
RETURN = '''

View file

@ -69,10 +69,10 @@ author:
EXAMPLES = '''
- name: Get scaleset info
azure_rm_resource_facts:
resource_group: "{{ resource_group }}"
resource_group: myResourceGroup
provider: compute
resource_type: virtualmachinescalesets
resource_name: "{{ scaleset_name }}"
resource_name: myVmss
api_version: "2017-12-01"
'''

View file

@ -73,7 +73,7 @@ EXAMPLES = '''
- name: Create a route
azure_rm_route:
name: foobar
resource_group: Testing
resource_group: myResourceGroup
address_prefix: 10.1.0.0/16
next_hop_type: virtual_network_gateway
route_table_name: table
@ -81,7 +81,7 @@ EXAMPLES = '''
- name: Delete a route
azure_rm_route:
name: foobar
resource_group: Testing
resource_group: myResourceGroup
route_table_name: table
state: absent
'''

View file

@ -60,7 +60,7 @@ EXAMPLES = '''
- name: Create a route table
azure_rm_routetable:
name: foobar
resource_group: Testing
resource_group: myResourceGroup
disable_bgp_route_propagation: False
tags:
purpose: testing
@ -69,14 +69,14 @@ EXAMPLES = '''
azure_rm_subnet:
name: subnet
virtual_network_name: virtualnetwork
resource_group: Testing
resource_group: myResourceGroup
address_prefix_cidr: "10.1.0.0/16"
route_table: foobar
- name: Delete a route table
azure_rm_routetable:
name: foobar
resource_group: Testing
resource_group: myResourceGroup
state: absent
'''
RETURN = '''

View file

@ -47,11 +47,11 @@ EXAMPLES = '''
- name: Get facts for one route table
azure_rm_routetable_facts:
name: Testing
resource_group: foo
resource_group: myResourceGroup
- name: Get facts for all route tables
azure_rm_routetable_facts:
resource_group: foo
resource_group: myResourceGroup
- name: Get facts by tags
azure_rm_routetable_facts:

View file

@ -136,7 +136,7 @@ EXAMPLES = '''
# Create a security group
- azure_rm_securitygroup:
resource_group: mygroup
resource_group: myResourceGroup
name: mysecgroup
purge_rules: yes
rules:
@ -168,7 +168,7 @@ EXAMPLES = '''
# Update rules on existing security group
- azure_rm_securitygroup:
resource_group: mygroup
resource_group: myResourceGroup
name: mysecgroup
rules:
- name: DenySSH
@ -190,7 +190,7 @@ EXAMPLES = '''
# Delete security group
- azure_rm_securitygroup:
resource_group: mygroup
resource_group: myResourceGroup
name: mysecgroup
state: absent
'''

View file

@ -49,12 +49,12 @@ author:
EXAMPLES = '''
- name: Get facts for one security group
azure_rm_securitygroup_facts:
resource_group: Testing
resource_group: myResourceGroup
name: secgroup001
- name: Get facts for all security groups
azure_rm_securitygroup_facts:
resource_group: Testing
resource_group: myResourceGroup
'''