firewall#

States module for managing Firewall.

async idem_azure.states.azure.network.firewall.present(hub, ctx, name: str, location: str, resource_group_name: str, firewall_name: str, subscription_id: str = None, tags: Dict = None, resource_id: str = None, zones: List[str] = None, sku: sku = None, firewall_policy_id: str = None, ip_configuration: List[ipConfiguration] = None, management_ip_configuration: managementIpConfiguration = None) → Dict[source]#

Create or update firewall.

Parameters:

  • name (str) – The identifier for this state.

  • location (str) – Resource location. Changing this forces a new resource to be created.

  • resource_group_name (str) – The name of the resource group.

  • subscription_id (str, Optional) – Subscription Unique id.

  • resource_id (str, Optional) – firewall resource id on Azure

  • tags (dict[str, str], Optional) – Resource tags.

  • firewall_name (str) – The name of the firewall.

  • zones (list[str]) – A list of availability zones denoting where the resource needs to come from.

  • sku (dict[str, Any], Optional) –

    The SKU of the Firewall.

    • name(str):

      SKU name of the Firewall. Possible values are AZFW_Hub and AZFW_VNet. Changing this forces a new resource to be created.

    • tier(str):

      SKU tier of the Firewall. Possible values are Premium, Standard and Basic.

  • firewall_policy_id (str) – The ID of the Firewall Policy applied to this Firewall.

  • ip_configuration (list[dict[str, Any]], Optional) –

    IP configuration of the Firewall.

    • name(str):

      SKU name of the Firewall. Possible values are AZFW_Hub and AZFW_VNet. Changing this forces a new resource to be created.

    • subnet_id(str):

      SKU tier of the Firewall. Possible values are Premium, Standard and Basic.

    • public_ip_address_id(str):

      SKU tier of the Firewall. Possible values are Premium, Standard and Basic.

  • management_ip_configuration (dict[str, Any], Optional) –

    Management IP configuration of the Firewall.

    • name(str):

      Specifies the name of the IP Configuration.

    • subnet_id(str):

      Reference to the subnet associated with the IP Configuration. Changing this forces a new resource to be created.

    • public_ip_address_id(str):

      The ID of the Public IP Address associated with the firewall.

Returns:

Dict

Examples

resource_is_present:
  azure.network.firewall.present:
    - name: my_firewall
    - subscription_id: my_sub_id
    - resource_group_name: my_rg-1
    - firewall_name: my-firewall
    - location: eastus
    - tags:
        key: valuer
    - zones:
        - 1
    - sku:
        name: AZFW_VNet
        tier: Premium
    - firewall_policy_id: my_fp_id
    - ip_configuration:
        - name: name
          subnet_id: my_sub_id
          public_ip_address_id: my_public_ip_address
    - management_ip_configuration:
          name: name
          subnet_id: my_AzureFirewallManagementSubnet_subnet
          public_ip_address_id: my_management_public_ip_addess
async idem_azure.states.azure.network.firewall.absent(hub, ctx, name: str, resource_group_name: str, firewall_name: str, subscription_id: str = None) → dict[source]#

Delete a firewall.

Parameters:

  • name (str) – The identifier for this state.

  • resource_group_name (str) – The name of the resource group.

  • firewall_name (str) – The name of the firewall.

  • subscription_id (str, Optional) – Subscription Unique id.

Returns:

Dict

Examples

resource_is_absent:
  azure.network.firewall.absent:
    - name: my-fp
    - subscription_id: my-subscription
    - resource_group_name: my-resource-group
    - firewall_name: my-fp
async idem_azure.states.azure.network.firewall.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Lists all firewall under the same subscription.

Returns:

Dict[str, Any]

Examples

$ idem describe azure.network.firewall