mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-07 08:54:01 -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
|
@ -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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue