mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Update azure_rm_dnszone related document (#56984)
* Update azure_rm_dnszone related documentation
This commit is contained in:
Fred-sun
Alicia Cozine
parent
a7e53906a6
commit
df442751f7
2 changed files with 24 additions and 16 deletions
|
|
@ -31,7 +31,7 @@ module: azure_rm_dnszone
|
|||
|
||||
version_added: "2.4"
|
||||
|
||||
short_description: Manage Azure DNS zones.
|
||||
short_description: Manage Azure DNS zones
|
||||
|
||||
description:
|
||||
- Creates and deletes Azure DNS zones.
|
||||
|
|
@ -43,19 +43,18 @@ options:
|
|||
required: true
|
||||
name:
|
||||
description:
|
||||
- name of the DNS Zone.
|
||||
- Name of the DNS zone.
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- Assert the state of the zone. Use C(present) to create or update and
|
||||
C(absent) to delete.
|
||||
- Assert the state of the zone. Use C(present) to create or update and C(absent) to delete.
|
||||
default: present
|
||||
choices:
|
||||
- absent
|
||||
- present
|
||||
type:
|
||||
description:
|
||||
- The type of this DNS zone (public or private)
|
||||
- The type of this DNS zone (C(public) or C(private)).
|
||||
choices:
|
||||
- public
|
||||
- private
|
||||
|
|
@ -63,23 +62,24 @@ options:
|
|||
registration_virtual_networks:
|
||||
description:
|
||||
- A list of references to virtual networks that register hostnames in this DNS zone.
|
||||
- This is a only when I(type) is C(private).
|
||||
- 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.
|
||||
version_added: 2.8
|
||||
type: list
|
||||
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) is C(private).
|
||||
- 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.
|
||||
version_added: 2.8
|
||||
version_added: '2.8'
|
||||
type: list
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
- azure_tags
|
||||
|
||||
author: "Obezimnaka Boms (@ozboms)"
|
||||
author:
|
||||
- Obezimnaka Boms (@ozboms)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
@ -99,7 +99,8 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = '''
|
||||
state:
|
||||
description: Current state of the zone.
|
||||
description:
|
||||
- Current state of the zone.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ module: azure_rm_dnszone_facts
|
|||
|
||||
version_added: "2.4"
|
||||
|
||||
short_description: Get DNS zone facts.
|
||||
short_description: Get DNS zone facts
|
||||
|
||||
description:
|
||||
- Get facts for a specific DNS zone or all DNS zones within a resource group.
|
||||
|
|
@ -39,7 +39,7 @@ extends_documentation_fragment:
|
|||
- azure_tags
|
||||
|
||||
author:
|
||||
- "Obezimnaka Boms (@ozboms)"
|
||||
- Obezimnaka Boms (@ozboms)
|
||||
|
||||
'''
|
||||
|
||||
|
|
@ -61,7 +61,8 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = '''
|
||||
azure_dnszones:
|
||||
description: List of zone dicts.
|
||||
description:
|
||||
- List of zone dicts.
|
||||
returned: always
|
||||
type: list
|
||||
example: [{
|
||||
|
|
@ -74,7 +75,8 @@ azure_dnszones:
|
|||
"tags": {}
|
||||
}]
|
||||
dnszones:
|
||||
description: List of zone dicts, which share the same layout as azure_rm_dnszone module parameter.
|
||||
description:
|
||||
- List of zone dicts, which share the same layout as azure_rm_dnszone module parameter.
|
||||
returned: always
|
||||
type: list
|
||||
contains:
|
||||
|
|
@ -84,31 +86,36 @@ dnszones:
|
|||
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/dnszones/azure.com"
|
||||
name:
|
||||
description:
|
||||
- name of the DNS Zone.
|
||||
- name of the DNS zone.
|
||||
sample: azure.com
|
||||
type:
|
||||
description:
|
||||
- The type of this DNS zone (public or private)
|
||||
- The type of this DNS zone (C(public) or C(private)).
|
||||
sample: private
|
||||
registration_virtual_networks:
|
||||
description:
|
||||
- A list of references to virtual networks that register hostnames in this DNS zone.
|
||||
type: list
|
||||
sample: ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/bar"]
|
||||
resolution_virtual_networks:
|
||||
description:
|
||||
- A list of references to virtual networks that resolve records in this DNS zone.
|
||||
type: list
|
||||
sample: ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/deadbeef"]
|
||||
number_of_record_sets:
|
||||
description:
|
||||
- The current number of record sets in this DNS zone.
|
||||
type: int
|
||||
sample: 2
|
||||
max_number_of_record_sets:
|
||||
description:
|
||||
- The maximum number of record sets that can be created in this DNS zone.
|
||||
type: int
|
||||
sample: 5000
|
||||
name_servers:
|
||||
description:
|
||||
- The name servers for this DNS zone.
|
||||
type: list
|
||||
sample: [
|
||||
"ns1-03.azure-dns.com.",
|
||||
"ns2-03.azure-dns.net.",
|
||||
|
|
|
|||
Loading…
Reference in a new issue