Update azure_rm_dnszone related document (#56984)

*  Update azure_rm_dnszone related documentation
This commit is contained in:
Fred-sun 2019-05-30 10:31:12 -04:00 committed by Alicia Cozine
commit df442751f7
2 changed files with 24 additions and 16 deletions

View file

@ -31,7 +31,7 @@ module: azure_rm_dnszone
version_added: "2.4" version_added: "2.4"
short_description: Manage Azure DNS zones. short_description: Manage Azure DNS zones
description: description:
- Creates and deletes Azure DNS zones. - Creates and deletes Azure DNS zones.
@ -43,19 +43,18 @@ options:
required: true required: true
name: name:
description: description:
- name of the DNS Zone. - Name of the DNS zone.
required: true required: true
state: state:
description: description:
- Assert the state of the zone. Use C(present) to create or update and - Assert the state of the zone. Use C(present) to create or update and C(absent) to delete.
C(absent) to delete.
default: present default: present
choices: choices:
- absent - absent
- present - present
type: type:
description: description:
- The type of this DNS zone (public or private) - The type of this DNS zone (C(public) or C(private)).
choices: choices:
- public - public
- private - private
@ -63,23 +62,24 @@ options:
registration_virtual_networks: registration_virtual_networks:
description: description:
- A list of references to virtual networks that register hostnames in this DNS zone. - 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. - 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 type: list
resolution_virtual_networks: resolution_virtual_networks:
description: description:
- A list of references to virtual networks that resolve records in this DNS zone. - 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. - 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 type: list
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
- azure_tags - azure_tags
author: "Obezimnaka Boms (@ozboms)" author:
- Obezimnaka Boms (@ozboms)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -99,7 +99,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
state: state:
description: Current state of the zone. description:
- Current state of the zone.
returned: always returned: always
type: dict type: dict
sample: { sample: {

View file

@ -18,7 +18,7 @@ module: azure_rm_dnszone_facts
version_added: "2.4" version_added: "2.4"
short_description: Get DNS zone facts. short_description: Get DNS zone facts
description: description:
- Get facts for a specific DNS zone or all DNS zones within a resource group. - Get facts for a specific DNS zone or all DNS zones within a resource group.
@ -39,7 +39,7 @@ extends_documentation_fragment:
- azure_tags - azure_tags
author: author:
- "Obezimnaka Boms (@ozboms)" - Obezimnaka Boms (@ozboms)
''' '''
@ -61,7 +61,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
azure_dnszones: azure_dnszones:
description: List of zone dicts. description:
- List of zone dicts.
returned: always returned: always
type: list type: list
example: [{ example: [{
@ -74,7 +75,8 @@ azure_dnszones:
"tags": {} "tags": {}
}] }]
dnszones: 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 returned: always
type: list type: list
contains: contains:
@ -84,31 +86,36 @@ dnszones:
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/dnszones/azure.com" sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/dnszones/azure.com"
name: name:
description: description:
- name of the DNS Zone. - name of the DNS zone.
sample: azure.com sample: azure.com
type: type:
description: description:
- The type of this DNS zone (public or private) - The type of this DNS zone (C(public) or C(private)).
sample: private sample: private
registration_virtual_networks: registration_virtual_networks:
description: description:
- A list of references to virtual networks that register hostnames in this DNS zone. - 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"] sample: ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/bar"]
resolution_virtual_networks: resolution_virtual_networks:
description: description:
- A list of references to virtual networks that resolve records in this DNS zone. - 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"] sample: ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/deadbeef"]
number_of_record_sets: number_of_record_sets:
description: description:
- The current number of record sets in this DNS zone. - The current number of record sets in this DNS zone.
type: int
sample: 2 sample: 2
max_number_of_record_sets: max_number_of_record_sets:
description: description:
- The maximum number of record sets that can be created in this DNS zone. - The maximum number of record sets that can be created in this DNS zone.
type: int
sample: 5000 sample: 5000
name_servers: name_servers:
description: description:
- The name servers for this DNS zone. - The name servers for this DNS zone.
type: list
sample: [ sample: [
"ns1-03.azure-dns.com.", "ns1-03.azure-dns.com.",
"ns2-03.azure-dns.net.", "ns2-03.azure-dns.net.",