From 6f197880ce83d43158dfb1bba1eb82f4b4e9689e Mon Sep 17 00:00:00 2001 From: Fred-sun <37327967+Fred-sun@users.noreply.github.com> Date: Sat, 9 Nov 2019 05:10:06 +0800 Subject: [PATCH] Update azure_rm_azurefirewall relate document (#64488) --- .../cloud/azure/azure_rm_azurefirewall.py | 391 +++++++++--------- .../azure/azure_rm_azurefirewall_info.py | 133 +++--- 2 files changed, 267 insertions(+), 257 deletions(-) diff --git a/lib/ansible/modules/cloud/azure/azure_rm_azurefirewall.py b/lib/ansible/modules/cloud/azure/azure_rm_azurefirewall.py index ec83fb2f466..51ff7f8429d 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_azurefirewall.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_azurefirewall.py @@ -17,207 +17,220 @@ DOCUMENTATION = ''' --- module: azure_rm_azurefirewall version_added: '2.9' -short_description: Manage Azure Firewall instance. +short_description: Manage Azure Firewall instance description: - - Create, update and delete instance of Azure Firewall. + - Create, update and delete instance of Azure Firewall. options: - resource_group: - description: - - The name of the resource group. - required: true - name: - description: - - The name of the Azure Firewall. - required: true - location: - description: - - Resource location. - application_rule_collections: - description: - - Collection of application rule collections used by Azure Firewall. - type: list - suboptions: - priority: + resource_group: description: - - Priority of the application rule collection resource. - type: int - action: + - The name of the resource group. + required: true + type: str + name: description: - - The action type of a rule collection - choices: - - allow - - deny - rules: + - The name of the Azure Firewall. + required: true + type: str + location: + description: + - Resource location. + type: str + application_rule_collections: description: - - Collection of rules used by a application rule collection. + - Collection of application rule collections used by Azure Firewall. type: list suboptions: - name: - description: - - Name of the application rule. - description: - description: - - Description of the rule. - source_addresses: - description: - - List of source IP addresses for this rule. - type: list - protocols: - description: - - Array of ApplicationRuleProtocols. - type: list - target_fqdns: - description: - - List of FQDNs for this rule. - type: list - fqdn_tags: - description: - - List of FQDN Tags for this rule. - type: list - name: - description: - - >- - Gets name of the resource that is unique within a resource group. - This name can be used to access the resource. - nat_rule_collections: - description: - - Collection of NAT rule collections used by Azure Firewall. - type: list - suboptions: - priority: - description: - - Priority of the NAT rule collection resource. - type: int - action: - description: - - The action type of a NAT rule collection - choices: - - snat - - dnat - rules: + priority: + description: + - Priority of the application rule collection resource. + type: int + action: + description: + - The action type of a rule collection. + choices: + - allow + - deny + type: str + rules: + description: + - Collection of rules used by a application rule collection. + type: list + suboptions: + name: + description: + - Name of the application rule. + type: str + description: + description: + - Description of the rule. + type: str + source_addresses: + description: + - List of source IP addresses for this rule. + type: list + protocols: + description: + - Array of ApplicationRuleProtocols. + type: list + target_fqdns: + description: + - List of FQDNs for this rule. + type: list + fqdn_tags: + description: + - List of FQDN Tags for this rule. + type: list + name: + description: + - Gets name of the resource that is unique within a resource group. + - This name can be used to access the resource. + type: str + nat_rule_collections: description: - - Collection of rules used by a NAT rule collection. + - Collection of NAT rule collections used by Azure Firewall. type: list suboptions: - name: - description: - - Name of the NAT rule. - description: - description: - - Description of the rule. - source_addresses: - description: - - List of source IP addresses for this rule. - type: list - destination_addresses: - description: - - List of destination IP addresses for this rule. - type: list - destination_ports: - description: - - List of destination ports. - type: list - protocols: - description: - - >- - Array of AzureFirewallNetworkRuleProtocols applicable to this - NAT rule. - type: list - translated_address: - description: - - The translated address for this NAT rule. - translated_port: - description: - - The translated port for this NAT rule. - name: - description: - - >- - Gets name of the resource that is unique within a resource group. - This name can be used to access the resource. - network_rule_collections: - description: - - Collection of network rule collections used by Azure Firewall. - type: list - suboptions: - priority: - description: - - Priority of the network rule collection resource. - type: int - action: - description: - - The action type of a rule collection - choices: - - allow - - deny - rules: + priority: + description: + - Priority of the NAT rule collection resource. + type: int + action: + description: + - The action type of a NAT rule collection + choices: + - snat + - dnat + type: str + rules: + description: + - Collection of rules used by a NAT rule collection. + type: list + suboptions: + name: + description: + - Name of the NAT rule. + type: str + description: + description: + - Description of the rule. + type: str + source_addresses: + description: + - List of source IP addresses for this rule. + type: list + destination_addresses: + description: + - List of destination IP addresses for this rule. + type: list + destination_ports: + description: + - List of destination ports. + type: list + protocols: + description: + - Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. + type: list + translated_address: + description: + - The translated address for this NAT rule. + type: str + translated_port: + description: + - The translated port for this NAT rule. + type: str + name: + description: + - Gets name of the resource that is unique within a resource group. + - This name can be used to access the resource. + type: str + network_rule_collections: description: - - Collection of rules used by a network rule collection. + - Collection of network rule collections used by Azure Firewall. type: list suboptions: - name: - description: - - Name of the network rule. - description: - description: - - Description of the rule. - protocols: - description: - - Array of AzureFirewallNetworkRuleProtocols. - type: list - source_addresses: - description: - - List of source IP addresses for this rule. - type: list - destination_addresses: - description: - - List of destination IP addresses. - type: list - destination_ports: - description: - - List of destination ports. - type: list - name: - description: - - >- - Gets name of the resource that is unique within a resource group. - This name can be used to access the resource. - ip_configurations: - description: - - IP configuration of the Azure Firewall resource. - type: list - suboptions: - subnet: - description: - - Existing subnet. - - It can be a string containing subnet resource id. - - It can be a dictionary containing C(name), C(virtual_network_name) and optionally C(resource_group) . - public_ip_address: + priority: + description: + - Priority of the network rule collection resource. + type: int + action: + description: + - The action type of a rule collection. + type: str + choices: + - allow + - deny + rules: + description: + - Collection of rules used by a network rule collection. + type: list + suboptions: + name: + description: + - Name of the network rule. + type: str + description: + description: + - Description of the rule. + type: str + protocols: + description: + - Array of AzureFirewallNetworkRuleProtocols. + type: list + source_addresses: + description: + - List of source IP addresses for this rule. + type: list + destination_addresses: + description: + - List of destination IP addresses. + type: list + destination_ports: + description: + - List of destination ports. + type: list + name: + description: + - Gets name of the resource that is unique within a resource group. + - This name can be used to access the resource. + type: str + ip_configurations: description: - - Existing public IP address - - It can be a string containing resource id. - - It can be a string containing a name in current resource group. - - It can be a dictionary containing C(name) and optionally C(resource_group). - name: + - IP configuration of the Azure Firewall resource. + type: list + suboptions: + subnet: + description: + - Existing subnet. + - It can be a string containing subnet resource ID. + - It can be a dictionary containing I(name), I(virtual_network_name) and optionally I(resource_group) . + type: raw + public_ip_address: + description: + - Existing public IP address. + - It can be a string containing resource ID. + - It can be a string containing a name in current resource group. + - It can be a dictionary containing I(name) and optionally I(resource_group). + type: raw + name: + description: + - Name of the resource that is unique within a resource group. + - This name can be used to access the resource. + type: str + state: description: - - >- - Name of the resource that is unique within a resource group. This - name can be used to access the resource. - state: - description: - - Assert the state of the AzureFirewall. - - >- - Use C(present) to create or update an AzureFirewall and C(absent) to - delete it. - default: present - choices: - - absent - - present + - Assert the state of the AzureFirewall. + - Use C(present) to create or update an AzureFirewall and C(absent) to delete it. + default: present + type: str + choices: + - absent + - present extends_documentation_fragment: - - azure - - azure_tags + - azure + - azure_tags author: - - Zim Kalinowski (@zikalino) - - Jurijs Fadejevs (@needgithubid) + - Zim Kalinowski (@zikalino) + - Jurijs Fadejevs (@needgithubid) ''' @@ -300,11 +313,11 @@ EXAMPLES = ''' RETURN = ''' id: - description: - - Resource ID. - returned: always - type: str - sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/azureFirewalls/myAzureFirewall + description: + - Resource ID. + returned: always + type: str + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/azureFirewalls/myAzureFirewall ''' import time diff --git a/lib/ansible/modules/cloud/azure/azure_rm_azurefirewall_info.py b/lib/ansible/modules/cloud/azure/azure_rm_azurefirewall_info.py index 3f612c820a9..d7c959e3dcc 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_azurefirewall_info.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_azurefirewall_info.py @@ -17,22 +17,22 @@ DOCUMENTATION = ''' --- module: azure_rm_azurefirewall_info version_added: '2.9' -short_description: Get AzureFirewall info. +short_description: Get AzureFirewall info description: - - Get info of AzureFirewall. + - Get info of AzureFirewall. options: - resource_group: - description: - - The name of the resource group. - type: str - name: - description: - - Resource name. - type: str + resource_group: + description: + - The name of the resource group. + type: str + name: + description: + - Resource name. + type: str extends_documentation_fragment: - - azure + - azure author: - - Liu Qingyi (@smile37773) + - Liu Qingyi (@smile37773) ''' @@ -51,62 +51,59 @@ EXAMPLES = ''' RETURN = ''' firewalls: - description: >- - A list of dict results where the key is the name of the AzureFirewall and - the values are the facts for that AzureFirewall. - returned: always - type: complex - contains: - id: - description: - - Resource ID. - returned: always - type: str - sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ - myResourceGroup/providers/Microsoft.Network/azureFirewalls/myAzureFirewall" - name: - description: - - Resource name. - returned: always - type: str - sample: "myAzureFirewall" - location: - description: - - Resource location. - returned: always - type: str - sample: "eastus" - tags: - description: - - Resource tags. - returned: always - type: dict - sample: { "tag": "value" } - etag: - description: - - >- - Gets a unique read-only string that changes whenever the resource - is updated. - returned: always - type: str - sample: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" - nat_rule_collections: - description: - - Collection of NAT rule collections used by Azure Firewall. - type: list - network_rule_collections: - description: - - Collection of network rule collections used by Azure Firewall. - type: list - ip_configurations: - description: - - IP configuration of the Azure Firewall resource. - type: list - provisioning_state: - description: - - The current state of the gallery. - type: str - sample: "Succeeded" + description: + - A list of dict results where the key is the name of the AzureFirewall and the values are the facts for that AzureFirewall. + returned: always + type: complex + contains: + id: + description: + - Resource ID. + returned: always + type: str + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ + myResourceGroup/providers/Microsoft.Network/azureFirewalls/myAzureFirewall" + name: + description: + - Resource name. + returned: always + type: str + sample: "myAzureFirewall" + location: + description: + - Resource location. + returned: always + type: str + sample: "eastus" + tags: + description: + - Resource tags. + returned: always + type: dict + sample: { "tag": "value" } + etag: + description: + - Gets a unique read-only string that changes whenever the resource is updated. + returned: always + type: str + sample: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + nat_rule_collections: + description: + - Collection of NAT rule collections used by Azure Firewall. + type: list + network_rule_collections: + description: + - Collection of network rule collections used by Azure Firewall. + type: list + ip_configurations: + description: + - IP configuration of the Azure Firewall resource. + type: list + provisioning_state: + description: + - The current state of the gallery. + type: str + sample: "Succeeded" '''