mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-08 02:01:31 -07:00
fix sample in docs (#55420)
This commit is contained in:
parent
339a0f4a8c
commit
22f666c962
13 changed files with 49 additions and 49 deletions
|
@ -203,7 +203,7 @@ author:
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
- name: Create a managed Azure Container Services (AKS) instance
|
- name: Create a managed Azure Container Services (AKS) instance
|
||||||
azure_rm_aks:
|
azure_rm_aks:
|
||||||
name: acctestaks1
|
name: myAKS
|
||||||
location: eastus
|
location: eastus
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
dns_prefix: akstest
|
dns_prefix: akstest
|
||||||
|
@ -222,7 +222,7 @@ EXAMPLES = '''
|
||||||
|
|
||||||
- name: Remove a managed Azure Container Services (AKS) instance
|
- name: Remove a managed Azure Container Services (AKS) instance
|
||||||
azure_rm_aks:
|
azure_rm_aks:
|
||||||
name: acctestaks3
|
name: myAKS
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
state: absent
|
state: absent
|
||||||
'''
|
'''
|
||||||
|
@ -244,7 +244,7 @@ state:
|
||||||
vnet_subnet_id: Null
|
vnet_subnet_id: Null
|
||||||
changed: false
|
changed: false
|
||||||
dns_prefix: aks9860bdcd89
|
dns_prefix: aks9860bdcd89
|
||||||
id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/yuwzhoaks/providers/Microsoft.ContainerService/managedClusters/aks9860bdc"
|
id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/aks9860bdc"
|
||||||
kube_config: "......"
|
kube_config: "......"
|
||||||
kubernetes_version: 1.11.4
|
kubernetes_version: 1.11.4
|
||||||
linux_profile:
|
linux_profile:
|
||||||
|
|
|
@ -377,7 +377,7 @@ EXAMPLES = '''
|
||||||
- name: Create instance of Application Gateway
|
- name: Create instance of Application Gateway
|
||||||
azure_rm_appgateway:
|
azure_rm_appgateway:
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
name: myappgateway
|
name: myAppGateway
|
||||||
sku:
|
sku:
|
||||||
name: standard_small
|
name: standard_small
|
||||||
tier: standard
|
tier: standard
|
||||||
|
|
|
@ -46,7 +46,7 @@ EXAMPLES = '''
|
||||||
- name: Get facts for app service plan by name
|
- name: Get facts for app service plan by name
|
||||||
azure_rm_appserviceplan_facts:
|
azure_rm_appserviceplan_facts:
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
name: winwebapp1
|
name: myAppServicePlan
|
||||||
|
|
||||||
- name: Get azure_rm_appserviceplan_facts for app service plan in resource group
|
- name: Get azure_rm_appserviceplan_facts for app service plan in resource group
|
||||||
azure_rm_webapp_facts:
|
azure_rm_webapp_facts:
|
||||||
|
|
|
@ -70,13 +70,13 @@ author:
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
- name: Create an availability set with default options
|
- name: Create an availability set with default options
|
||||||
azure_rm_availabilityset:
|
azure_rm_availabilityset:
|
||||||
name: myavailabilityset
|
name: myAvailabilitySet
|
||||||
location: eastus
|
location: eastus
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
|
|
||||||
- name: Create an availability set with advanced options
|
- name: Create an availability set with advanced options
|
||||||
azure_rm_availabilityset:
|
azure_rm_availabilityset:
|
||||||
name: myavailabilityset
|
name: myAvailabilitySet
|
||||||
location: eastus
|
location: eastus
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
platform_update_domain_count: 5
|
platform_update_domain_count: 5
|
||||||
|
@ -85,7 +85,7 @@ EXAMPLES = '''
|
||||||
|
|
||||||
- name: Delete an availability set
|
- name: Delete an availability set
|
||||||
azure_rm_availabilityset:
|
azure_rm_availabilityset:
|
||||||
name: myavailabilityset
|
name: myAvailabilitySet
|
||||||
location: eastus
|
location: eastus
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
state: absent
|
state: absent
|
||||||
|
|
|
@ -59,7 +59,7 @@ azure_availabilityset:
|
||||||
type: list
|
type: list
|
||||||
example: [{
|
example: [{
|
||||||
"location": "eastus2",
|
"location": "eastus2",
|
||||||
"name": "myavailabilityset",
|
"name": "myAvailabilitySet",
|
||||||
"properties": {
|
"properties": {
|
||||||
"platformFaultDomainCount": 3,
|
"platformFaultDomainCount": 3,
|
||||||
"platformUpdateDomainCount": 2,
|
"platformUpdateDomainCount": 2,
|
||||||
|
|
|
@ -63,7 +63,7 @@ EXAMPLES = '''
|
||||||
- name: Create a CDN profile
|
- name: Create a CDN profile
|
||||||
azure_rm_cdnprofile:
|
azure_rm_cdnprofile:
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
name: cdntest
|
name: myCDN
|
||||||
sku: standard_akamai
|
sku: standard_akamai
|
||||||
tags:
|
tags:
|
||||||
testing: testing
|
testing: testing
|
||||||
|
@ -71,7 +71,7 @@ EXAMPLES = '''
|
||||||
- name: Delete the CDN profile
|
- name: Delete the CDN profile
|
||||||
azure_rm_cdnprofile:
|
azure_rm_cdnprofile:
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
name: cdntest
|
name: myCDN
|
||||||
state: absent
|
state: absent
|
||||||
'''
|
'''
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
|
@ -80,7 +80,7 @@ id:
|
||||||
returned: always
|
returned: always
|
||||||
type: dict
|
type: dict
|
||||||
example:
|
example:
|
||||||
id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/cdntest/providers/Microsoft.Cdn/profiles/cdntest
|
id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/myCDN
|
||||||
'''
|
'''
|
||||||
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
|
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
|
||||||
|
|
||||||
|
|
|
@ -84,7 +84,7 @@ cdnprofiles:
|
||||||
description:
|
description:
|
||||||
- ID of the CDN profile.
|
- ID of the CDN profile.
|
||||||
type: str
|
type: str
|
||||||
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/cdntest
|
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/myCDN
|
||||||
provisioning_state:
|
provisioning_state:
|
||||||
description:
|
description:
|
||||||
- Provisioning status of the profile.
|
- Provisioning status of the profile.
|
||||||
|
|
|
@ -148,11 +148,11 @@ EXAMPLES = '''
|
||||||
- name: Create sample container group
|
- name: Create sample container group
|
||||||
azure_rm_containerinstance:
|
azure_rm_containerinstance:
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
name: mynewcontainergroup
|
name: myContainerInstanceGroup
|
||||||
os_type: linux
|
os_type: linux
|
||||||
ip_address: public
|
ip_address: public
|
||||||
containers:
|
containers:
|
||||||
- name: mycontainer1
|
- name: myContainer1
|
||||||
image: httpd
|
image: httpd
|
||||||
memory: 1.5
|
memory: 1.5
|
||||||
ports:
|
ports:
|
||||||
|
|
|
@ -45,7 +45,7 @@ EXAMPLES = '''
|
||||||
- name: Get specific Container Instance facts
|
- name: Get specific Container Instance facts
|
||||||
azure_rm_containerinstance_facts:
|
azure_rm_containerinstance_facts:
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
name: container_group_name
|
name: myContainer
|
||||||
|
|
||||||
- name: List Container Instances in a specified resource group name
|
- name: List Container Instances in a specified resource group name
|
||||||
azure_rm_containerinstance_facts:
|
azure_rm_containerinstance_facts:
|
||||||
|
|
|
@ -64,7 +64,7 @@ author:
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
- name: Create an azure container registry
|
- name: Create an azure container registry
|
||||||
azure_rm_containerregistry:
|
azure_rm_containerregistry:
|
||||||
name: testacr1
|
name: myRegistry
|
||||||
location: eastus
|
location: eastus
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
admin_user_enabled: true
|
admin_user_enabled: true
|
||||||
|
@ -75,7 +75,7 @@ EXAMPLES = '''
|
||||||
|
|
||||||
- name: Remove an azure container registry
|
- name: Remove an azure container registry
|
||||||
azure_rm_containerregistry:
|
azure_rm_containerregistry:
|
||||||
name: testacr2
|
name: myRegistry
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
state: absent
|
state: absent
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -50,7 +50,7 @@ EXAMPLES = '''
|
||||||
- name: Get instance of Registry
|
- name: Get instance of Registry
|
||||||
azure_rm_containerregistry_facts:
|
azure_rm_containerregistry_facts:
|
||||||
resource_group: myResourceGroup
|
resource_group: myResourceGroup
|
||||||
name: sampleregistry
|
name: myRegistry
|
||||||
|
|
||||||
- name: List instances of Registry
|
- name: List instances of Registry
|
||||||
azure_rm_containerregistry_facts:
|
azure_rm_containerregistry_facts:
|
||||||
|
|
|
@ -189,21 +189,21 @@ author:
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
- name: Create a windows web app with non-exist app service plan
|
- name: Create a windows web app with non-exist app service plan
|
||||||
azure_rm_webapp:
|
azure_rm_webapp:
|
||||||
resource_group: myresourcegroup
|
resource_group: myResourceGroup
|
||||||
name: mywinwebapp
|
name: myWinWebapp
|
||||||
plan:
|
plan:
|
||||||
resource_group: myappserviceplan_rg
|
resource_group: myAppServicePlan_rg
|
||||||
name: myappserviceplan
|
name: myAppServicePlan
|
||||||
is_linux: false
|
is_linux: false
|
||||||
sku: S1
|
sku: S1
|
||||||
|
|
||||||
- name: Create a docker web app with some app settings, with docker image
|
- name: Create a docker web app with some app settings, with docker image
|
||||||
azure_rm_webapp:
|
azure_rm_webapp:
|
||||||
resource_group: myresourcegroup
|
resource_group: myResourceGroup
|
||||||
name: mydockerwebapp
|
name: myDockerWebapp
|
||||||
plan:
|
plan:
|
||||||
resource_group: appserviceplan_test
|
resource_group: myAppServicePlan_rg
|
||||||
name: myappplan
|
name: myAppServicePlan
|
||||||
is_linux: true
|
is_linux: true
|
||||||
sku: S1
|
sku: S1
|
||||||
number_of_workers: 2
|
number_of_workers: 2
|
||||||
|
@ -215,9 +215,9 @@ EXAMPLES = '''
|
||||||
|
|
||||||
- name: Create a docker web app with private acr registry
|
- name: Create a docker web app with private acr registry
|
||||||
azure_rm_webapp:
|
azure_rm_webapp:
|
||||||
resource_group: myresourcegroup
|
resource_group: myResourceGroup
|
||||||
name: mydockerwebapp
|
name: myDockerWebapp
|
||||||
plan: myappplan
|
plan: myAppServicePlan
|
||||||
app_settings:
|
app_settings:
|
||||||
testkey: testvalue
|
testkey: testvalue
|
||||||
container_settings:
|
container_settings:
|
||||||
|
@ -228,11 +228,11 @@ EXAMPLES = '''
|
||||||
|
|
||||||
- name: Create a linux web app with Node 6.6 framework
|
- name: Create a linux web app with Node 6.6 framework
|
||||||
azure_rm_webapp:
|
azure_rm_webapp:
|
||||||
resource_group: myresourcegroup
|
resource_group: myResourceGroup
|
||||||
name: mylinuxwebapp
|
name: myLinuxWebapp
|
||||||
plan:
|
plan:
|
||||||
resource_group: appserviceplan_test
|
resource_group: myAppServicePlan_rg
|
||||||
name: myappplan
|
name: myAppServicePlan
|
||||||
app_settings:
|
app_settings:
|
||||||
testkey: testvalue
|
testkey: testvalue
|
||||||
frameworks:
|
frameworks:
|
||||||
|
@ -241,11 +241,11 @@ EXAMPLES = '''
|
||||||
|
|
||||||
- name: Create a windows web app with node, php
|
- name: Create a windows web app with node, php
|
||||||
azure_rm_webapp:
|
azure_rm_webapp:
|
||||||
resource_group: myresourcegroup
|
resource_group: myResourceGroup
|
||||||
name: mywinwebapp
|
name: myWinWebapp
|
||||||
plan:
|
plan:
|
||||||
resource_group: appserviceplan_test
|
resource_group: myAppServicePlan_rg
|
||||||
name: myappplan
|
name: myAppServicePlan
|
||||||
app_settings:
|
app_settings:
|
||||||
testkey: testvalue
|
testkey: testvalue
|
||||||
frameworks:
|
frameworks:
|
||||||
|
@ -256,21 +256,21 @@ EXAMPLES = '''
|
||||||
|
|
||||||
- name: Create a stage deployment slot for an existing web app
|
- name: Create a stage deployment slot for an existing web app
|
||||||
azure_rm_webapp:
|
azure_rm_webapp:
|
||||||
resource_group: myresourcegroup
|
resource_group: myResourceGroup
|
||||||
name: mywebapp/slots/stage
|
name: myWebapp/slots/stage
|
||||||
plan:
|
plan:
|
||||||
resource_group: myresourcegroup
|
resource_group: myAppServicePlan_rg
|
||||||
name: myappplan
|
name: myAppServicePlan
|
||||||
app_settings:
|
app_settings:
|
||||||
testkey:testvalue
|
testkey:testvalue
|
||||||
|
|
||||||
- name: Create a linux web app with java framework
|
- name: Create a linux web app with java framework
|
||||||
azure_rm_webapp:
|
azure_rm_webapp:
|
||||||
resource_group: myresourcegroup
|
resource_group: myResourceGroup
|
||||||
name: mylinuxwebapp
|
name: myLinuxWebapp
|
||||||
plan:
|
plan:
|
||||||
resource_group: appserviceplan_test
|
resource_group: myAppServicePlan_rg
|
||||||
name: myappplan
|
name: myAppServicePlan
|
||||||
app_settings:
|
app_settings:
|
||||||
testkey: testvalue
|
testkey: testvalue
|
||||||
frameworks:
|
frameworks:
|
||||||
|
@ -287,7 +287,7 @@ azure_webapp:
|
||||||
returned: always
|
returned: always
|
||||||
type: dict
|
type: dict
|
||||||
sample: {
|
sample: {
|
||||||
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/ansiblewindowsaaa"
|
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp"
|
||||||
}
|
}
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -75,7 +75,7 @@ webapps:
|
||||||
- Id of the web app.
|
- Id of the web app.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/xx
|
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name of the web app.
|
- Name of the web app.
|
||||||
|
@ -97,7 +97,7 @@ webapps:
|
||||||
- Id of app service plan used by the web app.
|
- Id of app service plan used by the web app.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/xxx
|
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/myAppServicePlan
|
||||||
app_settings:
|
app_settings:
|
||||||
description:
|
description:
|
||||||
- App settings of the application. Only returned when web app has app settings.
|
- App settings of the application. Only returned when web app has app settings.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue