mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 05:40:23 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -28,22 +28,16 @@ options:
|
|||
description:
|
||||
- name of the virtual machine and associated cloud service.
|
||||
required: true
|
||||
default: null
|
||||
location:
|
||||
description:
|
||||
- the azure location to use (e.g. 'East US')
|
||||
required: true
|
||||
default: null
|
||||
subscription_id:
|
||||
description:
|
||||
- azure subscription id. Overrides the AZURE_SUBSCRIPTION_ID environment variable.
|
||||
required: false
|
||||
default: null
|
||||
management_cert_path:
|
||||
description:
|
||||
- path to an azure management certificate associated with the subscription id. Overrides the AZURE_CERT_PATH environment variable.
|
||||
required: false
|
||||
default: null
|
||||
storage_account:
|
||||
description:
|
||||
- the azure storage account in which to store the data disks.
|
||||
|
@ -53,86 +47,65 @@ options:
|
|||
- system image for creating the virtual machine
|
||||
(e.g., b39f27a8b8c64d52b05eac6a62ebad85__Ubuntu_DAILY_BUILD-precise-12_04_3-LTS-amd64-server-20131205-en-us-30GB)
|
||||
required: true
|
||||
default: null
|
||||
role_size:
|
||||
description:
|
||||
- azure role size for the new virtual machine (e.g., Small, ExtraLarge, A6). You have to pay attention to the fact that instances of
|
||||
type G and DS are not available in all regions (locations). Make sure if you selected the size and type of instance available in your chosen location.
|
||||
required: false
|
||||
default: Small
|
||||
endpoints:
|
||||
description:
|
||||
- a comma-separated list of TCP ports to expose on the virtual machine (e.g., "22,80")
|
||||
required: false
|
||||
default: 22
|
||||
user:
|
||||
description:
|
||||
- the unix username for the new virtual machine.
|
||||
required: false
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- the unix password for the new virtual machine.
|
||||
required: false
|
||||
default: null
|
||||
ssh_cert_path:
|
||||
description:
|
||||
- path to an X509 certificate containing the public ssh key to install in the virtual machine.
|
||||
See http://www.windowsazure.com/en-us/manage/linux/tutorials/intro-to-linux/ for more details.
|
||||
- if this option is specified, password-based ssh authentication will be disabled.
|
||||
required: false
|
||||
default: null
|
||||
virtual_network_name:
|
||||
description:
|
||||
- Name of virtual network.
|
||||
required: false
|
||||
default: null
|
||||
hostname:
|
||||
description:
|
||||
- hostname to write /etc/hostname. Defaults to <name>.cloudapp.net.
|
||||
required: false
|
||||
default: null
|
||||
wait:
|
||||
description:
|
||||
- wait for the instance to be in state 'running' before returning
|
||||
required: false
|
||||
default: "no"
|
||||
choices: [ "yes", "no" ]
|
||||
aliases: []
|
||||
type: bool
|
||||
default: 'no'
|
||||
wait_timeout:
|
||||
description:
|
||||
- how long before wait gives up, in seconds
|
||||
default: 600
|
||||
aliases: []
|
||||
wait_timeout_redirects:
|
||||
description:
|
||||
- how long before wait gives up for redirects, in seconds
|
||||
default: 300
|
||||
aliases: []
|
||||
state:
|
||||
description:
|
||||
- create or terminate instances
|
||||
required: false
|
||||
choices: [ absent, present ]
|
||||
default: 'present'
|
||||
aliases: []
|
||||
auto_updates:
|
||||
description:
|
||||
- Enable Auto Updates on Windows Machines
|
||||
required: false
|
||||
version_added: "2.0"
|
||||
default: "no"
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
enable_winrm:
|
||||
description:
|
||||
- Enable winrm on Windows Machines
|
||||
required: false
|
||||
version_added: "2.0"
|
||||
default: "yes"
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
os_type:
|
||||
description:
|
||||
- The type of the os that is gettings provisioned
|
||||
required: false
|
||||
version_added: "2.0"
|
||||
default: "linux"
|
||||
choices: [ "windows", "linux" ]
|
||||
|
|
|
@ -36,12 +36,10 @@ options:
|
|||
choices:
|
||||
- absent
|
||||
- present
|
||||
required: false
|
||||
location:
|
||||
description:
|
||||
- Valid azure location. Defaults to location of the resource group.
|
||||
default: resource_group location
|
||||
required: false
|
||||
orchestration_platform:
|
||||
description:
|
||||
- Specifies the Container Orchestration Platform to use. Currently can be either DCOS, Kubernetes or Swarm.
|
||||
|
@ -105,8 +103,6 @@ options:
|
|||
service_principal:
|
||||
description:
|
||||
- The service principal suboptions.
|
||||
required: false
|
||||
default: null
|
||||
suboptions:
|
||||
client_id:
|
||||
description:
|
||||
|
|
|
@ -26,13 +26,9 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Limit results to a specific availability set
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- The resource group to search for the desired availability set
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -50,7 +50,6 @@ options:
|
|||
choices:
|
||||
- public
|
||||
- none
|
||||
default: None
|
||||
ports:
|
||||
description:
|
||||
- List of ports exposed within the container group.
|
||||
|
@ -93,7 +92,7 @@ options:
|
|||
description:
|
||||
- Force update of existing container instance. Any update will result in deletion and recreation of existing containers.
|
||||
type: bool
|
||||
default: False
|
||||
default: 'no'
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -27,7 +27,6 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Name of the Container Registry.
|
||||
default: null
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
|
@ -43,7 +42,8 @@ options:
|
|||
admin_user_enabled:
|
||||
description:
|
||||
- If enabled, you can use the registry name as username and admin user access key as password to docker login to your container registry.
|
||||
default: false
|
||||
type: bool
|
||||
default: no
|
||||
sku:
|
||||
description:
|
||||
- Specifies the SKU to use. Currently can be either Basic, Standard or Premium.
|
||||
|
|
|
@ -33,13 +33,11 @@ options:
|
|||
location:
|
||||
description:
|
||||
- The geo-locations in which the resource group will be located.
|
||||
required: false
|
||||
default: westus
|
||||
deployment_mode:
|
||||
description:
|
||||
- In incremental mode, resources are deployed without deleting existing resources that are not included in the template.
|
||||
In complete mode resources are deployed and existing resources in the resource group not included in the template are deleted.
|
||||
required: false
|
||||
default: incremental
|
||||
choices:
|
||||
- complete
|
||||
|
@ -49,7 +47,6 @@ options:
|
|||
- If state is "present", template will be created. If state is "present" and if deployment exists, it will be
|
||||
updated. If state is "absent", stack will be removed.
|
||||
default: present
|
||||
required: false
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
|
@ -57,26 +54,18 @@ options:
|
|||
description:
|
||||
- A hash containing the templates inline. This parameter is mutually exclusive with 'template_link'.
|
||||
Either one of them is required if "state" parameter is "present".
|
||||
required: false
|
||||
default: null
|
||||
template_link:
|
||||
description:
|
||||
- Uri of file containing the template body. This parameter is mutually exclusive with 'template'. Either one
|
||||
of them is required if "state" parameter is "present".
|
||||
required: false
|
||||
default: null
|
||||
parameters:
|
||||
description:
|
||||
- A hash of all the required template variables for the deployment template. This parameter is mutually exclusive
|
||||
with 'parameters_link'. Either one of them is required if "state" parameter is "present".
|
||||
required: false
|
||||
default: null
|
||||
parameters_link:
|
||||
description:
|
||||
- Uri of file containing the parameters body. This parameter is mutually exclusive with 'parameters'. Either
|
||||
one of them is required if "state" parameter is "present".
|
||||
required: false
|
||||
default: null
|
||||
deployment_name:
|
||||
description:
|
||||
- The name of the deployment to be tracked in the resource group deployment history. Re-using a deployment name
|
||||
|
@ -85,8 +74,8 @@ options:
|
|||
wait_for_deployment_completion:
|
||||
description:
|
||||
- Whether or not to block until the deployment has completed.
|
||||
default: yes
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'yes'
|
||||
wait_for_deployment_polling_period:
|
||||
description:
|
||||
- Time (in seconds) to wait between polls when waiting for deployment completion.
|
||||
|
|
|
@ -24,20 +24,14 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Only show results for a specific Function App
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- Limit results to a resource group. Required when filtering by name
|
||||
required: false
|
||||
default: null
|
||||
aliases:
|
||||
- resource_group_name
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -41,18 +41,12 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Limit results to a specific resource group.
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- The resource group to search for the desired load balancer
|
||||
required: false
|
||||
default: null
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -38,18 +38,12 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Limit results to a specific managed disk
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- Limit results to a specific resource group
|
||||
required: false
|
||||
default: null
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -50,7 +50,6 @@ options:
|
|||
description:
|
||||
- Valid azure location. Defaults to location of the resource group.
|
||||
default: resource_group location
|
||||
required: false
|
||||
virtual_network_name:
|
||||
description:
|
||||
- Name or id of an existing virtual network with which the network interface will be associated. Required
|
||||
|
@ -65,7 +64,6 @@ options:
|
|||
aliases:
|
||||
- subnet
|
||||
required: true
|
||||
default: null
|
||||
os_type:
|
||||
description:
|
||||
- Determines any rules to be added to a default security group. When creating a network interface, if no
|
||||
|
@ -95,7 +93,8 @@ options:
|
|||
- (Deprecate) When creating a network interface, if no public IP address name is provided a default public IP
|
||||
address will be created. Set to false, if you do not want a public IP address automatically created.
|
||||
- This option will be deprecated in 2.9, use I(ip_configurations) instead.
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
public_ip_address_name:
|
||||
description:
|
||||
- (Deprecate) Name of an existing public IP address object to associate with the security group.
|
||||
|
@ -103,7 +102,6 @@ options:
|
|||
aliases:
|
||||
- public_ip_address
|
||||
- public_ip_name
|
||||
default: null
|
||||
public_ip_allocation_method:
|
||||
description:
|
||||
- (Deprecate) If a public_ip_address_name is not provided, a default public IP address will be created. The allocation
|
||||
|
@ -146,7 +144,8 @@ options:
|
|||
primary:
|
||||
description:
|
||||
- Whether the ip configuration is the primary one in the list.
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: 2.5
|
||||
security_group_name:
|
||||
description:
|
||||
|
@ -154,13 +153,11 @@ options:
|
|||
default security group will be created.
|
||||
aliases:
|
||||
- security_group
|
||||
default: null
|
||||
open_ports:
|
||||
description:
|
||||
- When a default security group is created for a Linux host a rule will be added allowing inbound TCP
|
||||
connections to the default SSH port 22, and for a Windows host rules will be added allowing inbound
|
||||
access to RDP ports 3389 and 5986. Override the default ports by providing a list of open ports.
|
||||
default: null
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
- azure_tags
|
||||
|
|
|
@ -29,18 +29,12 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Only show results for a specific network interface.
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- Name of the resource group containing the network interface(s). Required when searching by name.
|
||||
required: false
|
||||
default: null
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -39,15 +39,12 @@ options:
|
|||
- Dynamic
|
||||
- Static
|
||||
default: Dynamic
|
||||
required: false
|
||||
domain_name_label:
|
||||
description:
|
||||
- The customizable portion of the FQDN assigned to public IP address. This is an explicit setting. If
|
||||
no value is provided, any existing value will be removed on an existing public IP.
|
||||
aliases:
|
||||
- domain_name_label
|
||||
required: false
|
||||
default: null
|
||||
name:
|
||||
description:
|
||||
- Name of the Public IP.
|
||||
|
@ -60,12 +57,10 @@ options:
|
|||
choices:
|
||||
- absent
|
||||
- present
|
||||
required: false
|
||||
location:
|
||||
description:
|
||||
- Valid azure location. Defaults to location of the resource group.
|
||||
default: resource_group location
|
||||
required: false
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -29,18 +29,12 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Only show results for a specific Public IP.
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- Limit results by resource group. Required when using name parameter.
|
||||
required: false
|
||||
default: null
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -26,14 +26,12 @@ options:
|
|||
description:
|
||||
- Remove a resource group and all associated resources. Use with state 'absent' to delete a resource
|
||||
group that contains resources.
|
||||
default: false
|
||||
required: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
location:
|
||||
description:
|
||||
- Azure location for the resource group. Required when creating a new resource group. Cannot
|
||||
be changed once resource group is created.
|
||||
required: false
|
||||
default: null
|
||||
name:
|
||||
description:
|
||||
- Name of the resource group.
|
||||
|
@ -47,7 +45,6 @@ options:
|
|||
choices:
|
||||
- absent
|
||||
- present
|
||||
required: false
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
- azure_tags
|
||||
|
|
|
@ -29,13 +29,9 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Limit results to a specific resource group.
|
||||
required: false
|
||||
default: null
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -31,28 +31,23 @@ options:
|
|||
- The set of default rules automatically added to a security group at creation. In general default
|
||||
rules will not be modified. Modify rules to shape the flow of traffic to or from a subnet or NIC. See
|
||||
rules below for the makeup of a rule dict.
|
||||
required: false
|
||||
default: null
|
||||
location:
|
||||
description:
|
||||
- Valid azure location. Defaults to location of the resource group.
|
||||
default: resource_group location
|
||||
required: false
|
||||
name:
|
||||
description:
|
||||
- Name of the security group to operate on.
|
||||
required: false
|
||||
default: null
|
||||
purge_default_rules:
|
||||
description:
|
||||
- Remove any existing rules not matching those defined in the default_rules parameter.
|
||||
default: false
|
||||
required: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
purge_rules:
|
||||
description:
|
||||
- Remove any existing rules not matching those defined in the rules parameters.
|
||||
default: false
|
||||
required: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
resource_group:
|
||||
description:
|
||||
- Name of the resource group the security group belongs to.
|
||||
|
@ -60,8 +55,6 @@ options:
|
|||
rules:
|
||||
description:
|
||||
- Set of rules shaping traffic flow to or from a subnet or NIC. Each rule is a dictionary.
|
||||
required: false
|
||||
default: null
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
|
@ -122,7 +115,6 @@ options:
|
|||
- Assert the state of the security group. Set to 'present' to create or update a security group. Set to
|
||||
'absent' to remove a security group.
|
||||
default: present
|
||||
required: false
|
||||
choices:
|
||||
- absent
|
||||
- present
|
||||
|
|
|
@ -29,8 +29,6 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Only show results for a specific security group.
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- Name of the resource group to use.
|
||||
|
@ -38,8 +36,6 @@ options:
|
|||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -31,29 +31,23 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Name of the storage account to update or create.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Assert the state of the storage account. Use 'present' to create or update a storage account and
|
||||
'absent' to delete an account.
|
||||
default: present
|
||||
required: false
|
||||
choices:
|
||||
- absent
|
||||
- present
|
||||
location:
|
||||
description:
|
||||
- Valid azure location. Defaults to location of the resource group.
|
||||
required: false
|
||||
default: resource_group location
|
||||
account_type:
|
||||
description:
|
||||
- "Type of storage account. Required when creating a storage account. NOTE: Standard_ZRS and Premium_LRS
|
||||
accounts cannot be changed to other account types, and other account types cannot be changed to
|
||||
Standard_ZRS or Premium_LRS."
|
||||
required: false
|
||||
default: null
|
||||
choices:
|
||||
- Premium_LRS
|
||||
- Standard_GRS
|
||||
|
@ -68,12 +62,9 @@ options:
|
|||
keys where 'name' is the CNAME source. Only one custom domain is supported per storage account at this
|
||||
time. To clear the existing custom domain, use an empty string for the custom domain name property.
|
||||
- Can be added to an existing storage account. Will be ignored during storage account creation.
|
||||
required: false
|
||||
default: null
|
||||
kind:
|
||||
description:
|
||||
- The 'kind' of storage.
|
||||
required: false
|
||||
default: 'Storage'
|
||||
choices:
|
||||
- Storage
|
||||
|
@ -82,7 +73,6 @@ options:
|
|||
access_tier:
|
||||
description:
|
||||
- The access tier for this storage account. Required for a storage account of kind 'BlobStorage'.
|
||||
required: false
|
||||
default: 'Storage'
|
||||
choices:
|
||||
- Hot
|
||||
|
|
|
@ -29,20 +29,14 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Only show results for a specific account.
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- Limit results to a resource group. Required when filtering by name.
|
||||
required: false
|
||||
default: null
|
||||
aliases:
|
||||
- resource_group_name
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -33,14 +33,11 @@ options:
|
|||
blob:
|
||||
description:
|
||||
- Name of a blob object within the container.
|
||||
required: false
|
||||
default: null
|
||||
aliases:
|
||||
- blob_name
|
||||
blob_type:
|
||||
description:
|
||||
- Type of Blob Object.
|
||||
required: false
|
||||
default: block
|
||||
choices:
|
||||
- block
|
||||
|
@ -55,46 +52,32 @@ options:
|
|||
content_type:
|
||||
description:
|
||||
- Set the blob content-type header. For example, 'image/png'.
|
||||
default: null
|
||||
required: false
|
||||
cache_control:
|
||||
description:
|
||||
- Set the blob cache-control header.
|
||||
required: false
|
||||
default: null
|
||||
content_disposition:
|
||||
description:
|
||||
- Set the blob content-disposition header.
|
||||
required: false
|
||||
default: null
|
||||
content_encoding:
|
||||
description:
|
||||
- Set the blob encoding header.
|
||||
required: false
|
||||
default: null
|
||||
content_language:
|
||||
description:
|
||||
- Set the blob content-language header.
|
||||
required: false
|
||||
default: null
|
||||
content_md5:
|
||||
description:
|
||||
- Set the blob md5 hash value.
|
||||
required: false
|
||||
default: null
|
||||
dest:
|
||||
description:
|
||||
- Destination file path. Use with state 'present' to download a blob.
|
||||
aliases:
|
||||
- destination
|
||||
required: false
|
||||
default: null
|
||||
force:
|
||||
description:
|
||||
- Overwrite existing blob or file when uploading or downloading. Force deletion of a container
|
||||
that contains blobs.
|
||||
default: false
|
||||
required: false
|
||||
type: bool
|
||||
default: no
|
||||
resource_group:
|
||||
description:
|
||||
- Name of the resource group to use.
|
||||
|
@ -106,8 +89,6 @@ options:
|
|||
- Source file path. Use with state 'present' to upload a blob.
|
||||
aliases:
|
||||
- source
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Assert the state of a container or blob.
|
||||
|
@ -120,7 +101,6 @@ options:
|
|||
to download. If a blob (uploading) or a file (downloading) already exists, it will not be overwritten
|
||||
unless the force parameter is true.
|
||||
default: present
|
||||
required: false
|
||||
choices:
|
||||
- absent
|
||||
- present
|
||||
|
@ -128,8 +108,6 @@ options:
|
|||
description:
|
||||
- Determine a container's level of public access. By default containers are private. Can only be set at
|
||||
time of container creation.
|
||||
required: false
|
||||
default: null
|
||||
choices:
|
||||
- container
|
||||
- blob
|
||||
|
|
|
@ -42,15 +42,12 @@ options:
|
|||
security_group_name:
|
||||
description:
|
||||
- Name of an existing security group with which to associate the subnet.
|
||||
required: false
|
||||
default: null
|
||||
aliases:
|
||||
- security_group
|
||||
state:
|
||||
description:
|
||||
- Assert the state of the subnet. Use 'present' to create or update a subnet and
|
||||
'absent' to delete a subnet.
|
||||
required: false
|
||||
default: present
|
||||
choices:
|
||||
- absent
|
||||
|
|
|
@ -41,8 +41,6 @@ options:
|
|||
custom_data:
|
||||
description:
|
||||
- Data which is made available to the virtual machine and used by e.g., cloud-init.
|
||||
default: null
|
||||
required: false
|
||||
version_added: "2.5"
|
||||
state:
|
||||
description:
|
||||
|
@ -66,7 +64,6 @@ options:
|
|||
restarted:
|
||||
description:
|
||||
- Use with state 'present' to restart a running VM.
|
||||
default: false
|
||||
location:
|
||||
description:
|
||||
- Valid Azure location. Defaults to location of the resource group.
|
||||
|
@ -115,7 +112,6 @@ options:
|
|||
availability_set:
|
||||
description:
|
||||
- Name or ID of an existing availability set to add the VM to. The availability_set should be in the same resource group as VM.
|
||||
default: null
|
||||
version_added: "2.5"
|
||||
storage_account_name:
|
||||
description:
|
||||
|
@ -159,8 +155,6 @@ options:
|
|||
data_disks:
|
||||
description:
|
||||
- Describes list of data disks.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
suboptions:
|
||||
lun:
|
||||
|
|
|
@ -128,8 +128,6 @@ options:
|
|||
data_disks:
|
||||
description:
|
||||
- Describes list of data disks.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
suboptions:
|
||||
lun:
|
||||
|
|
|
@ -26,13 +26,9 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Limit results to a specific virtual machine scale set
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- The resource group to search for the desired virtual machine scale set
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -29,8 +29,6 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Only show results for a specific security group.
|
||||
default: null
|
||||
required: false
|
||||
location:
|
||||
description:
|
||||
- Azure location value (ie. westus, eastus, eastus2, northcentralus, etc.). Supplying only a
|
||||
|
@ -39,23 +37,15 @@ options:
|
|||
publisher:
|
||||
description:
|
||||
- Name of an image publisher. List image offerings associated with a particular publisher.
|
||||
default: null
|
||||
required: false
|
||||
offer:
|
||||
description:
|
||||
- Name of an image offering. Combine with sku to see a list of available image versions.
|
||||
default: null
|
||||
required: false
|
||||
sku:
|
||||
description:
|
||||
- Image offering SKU. Combine with offer to see a list of available versions.
|
||||
default: null
|
||||
required: false
|
||||
version:
|
||||
description:
|
||||
- Specific version number of an image.
|
||||
default: null
|
||||
required: false
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -33,21 +33,16 @@ options:
|
|||
a new virtual network or using purge_address_prefixes.
|
||||
aliases:
|
||||
- address_prefixes
|
||||
default: null
|
||||
required: false
|
||||
dns_servers:
|
||||
description:
|
||||
- Custom list of DNS servers. Maximum length of two. The first server in the list will be treated
|
||||
as the Primary server. This is an explicit list. Existing DNS servers will be replaced with the
|
||||
specified list. Use the purge_dns_servers option to remove all custom DNS servers and revert to
|
||||
default Azure servers.
|
||||
default: null
|
||||
required: false
|
||||
location:
|
||||
description:
|
||||
- Valid azure location. Defaults to location of the resource group.
|
||||
default: resource_group location
|
||||
required: false
|
||||
name:
|
||||
description:
|
||||
- name of the virtual network.
|
||||
|
@ -55,13 +50,14 @@ options:
|
|||
purge_address_prefixes:
|
||||
description:
|
||||
- Use with state present to remove any existing address_prefixes.
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
purge_dns_servers:
|
||||
description:
|
||||
- Use with state present to remove existing DNS servers, reverting to default Azure servers. Mutually
|
||||
exclusive with dns_servers.
|
||||
default: false
|
||||
required: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
state:
|
||||
description:
|
||||
- Assert the state of the virtual network. Use 'present' to create or update and
|
||||
|
@ -70,7 +66,6 @@ options:
|
|||
choices:
|
||||
- absent
|
||||
- present
|
||||
required: false
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
|
@ -29,18 +29,12 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Only show results for a specific security group.
|
||||
default: null
|
||||
required: false
|
||||
resource_group:
|
||||
description:
|
||||
- Limit results by resource group. Required when filtering by name.
|
||||
default: null
|
||||
required: false
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
default: null
|
||||
required: false
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue