Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the document to meet the change requirements of ansibe2.14 #814

Merged
merged 6 commits into from
Apr 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions plugins/doc_fragments/azure_rm.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,6 @@ class ModuleDocFragment(object):
resulted in a valid hostname.
- Use ``default_inventory_hostname`` to access the default hostname generator's value in any of the Jinja2 expressions.
type: list
elements: str
default: [default]
'''
2 changes: 2 additions & 0 deletions plugins/modules/azure_rm_aks.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@
description:
- Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.
type: list
elements: int
choices:
- 1
- 2
Expand Down Expand Up @@ -206,6 +207,7 @@
- Authorized IP Ranges to kubernetes API server.
- Cannot be enabled when using private cluster
type: list
elements: str
enable_private_cluster:
description:
- Whether to create the cluster as a private cluster or not.
Expand Down
2 changes: 2 additions & 0 deletions plugins/modules/azure_rm_cdnendpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
description:
- Use with I(state=present) and I(purge=true) to specify content paths to be purged.
type: list
elements: str
default: ['/']
profile_name:
description:
Expand Down Expand Up @@ -80,6 +81,7 @@
- List of content types on which compression applies.
- This value should be a valid MIME type.
type: list
elements: str
is_compression_enabled:
description:
- Indicates whether content compression is enabled on CDN.
Expand Down
2 changes: 2 additions & 0 deletions plugins/modules/azure_rm_datalakestore.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
description:
- The list of firewall rules associated with this Data Lake Store account.
type: list
elements: dict
suboptions:
name:
description:
Expand Down Expand Up @@ -144,6 +145,7 @@
description:
- The list of virtual network rules associated with this Data Lake Store account.
type: list
elements: dict
suboptions:
name:
description:
Expand Down
2 changes: 2 additions & 0 deletions plugins/modules/azure_rm_dnszone.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,14 @@
- This is a only when I(type=private).
- Each element can be the name or resource id, or a dict contains C(name), C(resource_group) information of the virtual network.
type: list
elements: raw
resolution_virtual_networks:
description:
- A list of references to virtual networks that resolve records in this DNS zone.
- This is a only when I(type=private).
- Each element can be the name or resource id, or a dict contains C(name), C(resource_group) information of the virtual network.
type: list
elements: raw

extends_documentation_fragment:
- azure.azcollection.azure
Expand Down
3 changes: 3 additions & 0 deletions plugins/modules/azure_rm_iothub.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@
description:
- Configure rules for rejecting or accepting traffic from specific IPv4 addresses.
type: list
elements: dict
suboptions:
name:
description:
Expand All @@ -105,6 +106,7 @@
description:
- Custom endpoints.
type: list
elements: dict
suboptions:
name:
description:
Expand Down Expand Up @@ -149,6 +151,7 @@
description:
- Route device-to-cloud messages to service-facing endpoints.
type: list
elements: dict
suboptions:
name:
description:
Expand Down
2 changes: 2 additions & 0 deletions plugins/modules/azure_rm_monitorlogprofile.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,12 @@
description:
- List of regions for which Activity Log events should be stored.
type: list
elements: str
categories:
description:
- List of categories of logs. These categories are created as is convenient to user. Some Values are C(Write), C(Delete) and/or C(Action).
type: list
elements: str
retention_policy:
description:
- Retention policy for events in the log.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/azure_rm_mysqlserver.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@
- Server version.
type: str
choices:
- 5.7
- 8.0
- '5.7'
- '8.0'
enforce_ssl:
description:
- Enable SSL enforcement.
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/azure_rm_registrationdefinition.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
- Authorization tuple containing principal ID of the user/security group or service principal and ID of the build-in role.
required: true
type: list
elements: dict
suboptions:
principal_id:
description:
Expand Down
2 changes: 2 additions & 0 deletions plugins/modules/azure_rm_securitygroup.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@
- It could be list of dict containing resource_group and name.
- It is mutually exclusive with C(source_address_prefix) and C(source_address_prefixes).
type: list
elements: raw
destination_application_security_groups:
description:
- List of the destination application security groups.
Expand All @@ -110,6 +111,7 @@
- It could be list of dict containing I(resource_group) and I(name).
- It is mutually exclusive with C(destination_address_prefix) and C(destination_address_prefixes).
type: list
elements: raw
access:
description:
- Whether or not to allow the traffic flow.
Expand Down
5 changes: 5 additions & 0 deletions plugins/modules/azure_rm_storageaccount.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,16 +153,19 @@
- If no blob_cors elements are included in the argument list, nothing about CORS will be changed.
- If you want to delete all CORS rules and disable CORS for the Blob service, explicitly set I(blob_cors=[]).
type: list
elements: dict
suboptions:
allowed_origins:
description:
- A list of origin domains that will be allowed via CORS, or "*" to allow all domains.
type: list
elements: str
required: true
allowed_methods:
description:
- A list of HTTP methods that are allowed to be executed by the origin.
type: list
elements: str
required: true
max_age_in_seconds:
description:
Expand All @@ -173,11 +176,13 @@
description:
- A list of response headers to expose to CORS clients.
type: list
elements: str
required: true
allowed_headers:
description:
- A list of headers allowed to be part of the cross-origin request.
type: list
elements: str
required: true

extends_documentation_fragment:
Expand Down
3 changes: 2 additions & 1 deletion plugins/modules/azure_rm_subscription_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,10 @@
type: bool
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
- Limit results by providing a list of tags. Format tags as 'key:value'.
- Option has no effect when searching by id or name, and will be silently ignored.
type: list
elements: dict

extends_documentation_fragment:
- azure.azcollection.azure
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/azure_rm_trafficmanagerendpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
description:
- The list of countries/regions mapped to this endpoint when traffic manager profile has routing_method of C(geographic).
type: list
elements: str
state:
description:
- Assert the state of the Traffic Manager endpoint. Use C(present) to create or update a Traffic Manager endpoint and C(absent) to delete it.
Expand Down
6 changes: 6 additions & 0 deletions plugins/modules/azure_rm_vpnsite.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
description:
- A list of address blocks reserved for this virtual network in CIDR notation.
type: list
elements: str
bgp_properties:
description:
- The set of bgp properties.
Expand All @@ -94,6 +95,7 @@
description:
- BGP peering address with IP configuration ID for virtual network gateway.
type: list
elements: dict
suboptions:
ipconfiguration_id:
description:
Expand All @@ -103,14 +105,17 @@
description:
- The list of default BGP peering addresses which belong to IP configuration.
type: list
elements: str
custom_bgp_ip_addresses:
description:
- The list of custom BGP peering addresses which belong to IP configuration.
type: list
elements: str
tunnel_ip_addresses:
description:
- The list of tunnel public IP addresses which belong to IP configuration.
type: list
elements: str
is_security_site:
description:
- IsSecuritySite flag.
Expand All @@ -119,6 +124,7 @@
description:
- List of all vpn site links.
type: list
elements: dict
suboptions:
name:
description:
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/azure_rm_webapp.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@
- The minimum TLS encryption version required for the app.
type: str
choices:
- 1.0
- 1.1
- 1.2
- '1.0'
- '1.1'
- '1.2'

ftps_state:
description:
Expand Down
9 changes: 0 additions & 9 deletions tests/sanity/ignore-2.10.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,13 @@ plugins/modules/azure_rm_containerregistrywebhook.py validate-modules:parameter-
plugins/modules/azure_rm_containerregistrywebhook_info.py validate-modules:doc-default-does-not-match-spec
plugins/modules/azure_rm_containerregistrywebhook_info.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_containerregistrywebhook_info.py validate-modules:undocumented-parameter
plugins/modules/azure_rm_datalakestore.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_datalakestore.py validate-modules:nonexistent-parameter-documented
plugins/modules/azure_rm_deployment.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_deployment.py validate-modules:return-syntax-error
plugins/modules/azure_rm_deployment_info.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_deployment_info.py validate-modules:return-syntax-error
plugins/modules/azure_rm_dnsrecordset.py validate-modules:invalid-ansiblemodule-schema
plugins/modules/azure_rm_dnszone.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_dnszone.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_dnszone_info.py validate-modules:doc-type-does-not-match-spec
plugins/modules/azure_rm_dnszone_info.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_dnszone_info.py validate-modules:parameter-list-no-elements
Expand All @@ -72,7 +70,6 @@ plugins/modules/azure_rm_image.py validate-modules:parameter-list-no-elements
plugins/modules/azure_rm_image_info.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_image_info.py validate-modules:parameter-list-no-elements
plugins/modules/azure_rm_image_info.py validate-modules:return-syntax-error
plugins/modules/azure_rm_iothub.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_iothub_info.py validate-modules:parameter-list-no-elements
plugins/modules/azure_rm_iothubconsumergroup.py validate-modules:doc-required-mismatch
plugins/modules/azure_rm_keyvault.py validate-modules:doc-choices-do-not-match-spec
Expand Down Expand Up @@ -109,7 +106,6 @@ plugins/modules/azure_rm_resource_info.py validate-modules:parameter-list-no-ele
plugins/modules/azure_rm_resourcegroup.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_resourcegroup_info.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_resourcegroup_info.py validate-modules:parameter-list-no-elements
plugins/modules/azure_rm_registrationdefinition.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_registrationdefinition.py validate-modules:invalid-ansiblemodule-schema
plugins/modules/azure_rm_registrationassignment.py validate-modules:invalid-ansiblemodule-schema
plugins/modules/azure_rm_securitygroup.py validate-modules:doc-choices-do-not-match-spec
Expand All @@ -124,7 +120,6 @@ plugins/modules/azure_rm_securitygroup_info.py validate-modules:parameter-type-n
plugins/modules/azure_rm_securitygroup_info.py validate-modules:parameter-list-no-elements
plugins/modules/azure_rm_storageaccount.py validate-modules:doc-missing-type
plugins/modules/azure_rm_storageaccount.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_storageaccount.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_storageaccount.py validate-modules:doc-required-mismatch
plugins/modules/azure_rm_storageaccount_info.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_storageaccount_info.py validate-modules:parameter-list-no-elements
Expand All @@ -133,7 +128,6 @@ plugins/modules/azure_rm_storageblob.py validate-modules:parameter-type-not-in-d
plugins/modules/azure_rm_subnet.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_subnet.py validate-modules:parameter-list-no-elements
plugins/modules/azure_rm_subnet_info.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_subscription_info.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_virtualmachine.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_virtualmachine.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_virtualmachine.py validate-modules:doc-required-mismatch
Expand Down Expand Up @@ -218,7 +212,6 @@ plugins/modules/azure_rm_mariadbdatabase.py validate-modules:parameter-type-not-
plugins/modules/azure_rm_mariadbfirewallrule.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_mariadbserver.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_mariadbserver_info.py validate-modules:parameter-list-no-elements
plugins/modules/azure_rm_monitorlogprofile.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_mysqlconfiguration.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_mysqlconfiguration_info.py validate-modules:return-syntax-error
plugins/modules/azure_rm_mysqldatabase.py validate-modules:parameter-type-not-in-doc
Expand Down Expand Up @@ -268,7 +261,6 @@ plugins/modules/azure_rm_trafficmanager.py validate-modules:undocumented-paramet
plugins/modules/azure_rm_trafficmanager.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_trafficmanager.py validate-modules:doc-required-mismatch
plugins/modules/azure_rm_trafficmanagerendpoint.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_trafficmanagerendpoint.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_trafficmanagerendpoint_info.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_trafficmanagerprofile.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_trafficmanagerprofile.py validate-modules:doc-choices-do-not-match-spec
Expand All @@ -290,7 +282,6 @@ plugins/modules/azure_rm_virtualnetworkgateway.py validate-modules:doc-missing-t
plugins/modules/azure_rm_virtualnetworkgateway.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_virtualnetworkgateway.py validate-modules:doc-required-mismatch
plugins/modules/azure_rm_vpnsite.py validate-modules:invalid-ansiblemodule-schema
plugins/modules/azure_rm_vpnsite.py validate-modules:doc-elements-mismatch
plugins/modules/azure_rm_batchaccount.py validate-modules:parameter-type-not-in-doc
plugins/modules/azure_rm_batchaccount.py validate-modules:invalid-ansiblemodule-schema
plugins/modules/azure_rm_cdnendpoint_info.py validate-modules:parameter-type-not-in-doc
Expand Down
Loading