public_ip_addresses#

State module for managing Public IP Address.

async idem_azure.states.azure.network.public_ip_addresses.present(hub, ctx, name: str, resource_group_name: str, public_ip_address_name: str, location: str, allocation_method: str, zones: List[str] = None, ddos_protection_mode: str = None, ddos_protection_plan_id: str = None, domain_name_label: str = None, edge_zone: str = None, idle_timeout_in_minutes: int = None, ip_address: str = None, ip_tags: Dict[str, str] = None, ip_version: str = None, public_ip_prefix_id: str = None, reverse_fqdn: str = None, linked_public_ip_address_id: str = None, service_public_ip_address_id: str = None, migration_phase: str = None, sku: str = None, sku_tier: str = None, tags: Dict[str, str] = None, extended_location: Dict[str, str] = None, subscription_id: str = None, resource_id: str = None) → Dict[source]#

Create or update Public IP Addresses.

Parameters:

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

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

  • public_ip_address_name (str) – The name of the public IP address.

  • location (str) – Resource location.

  • allocation_method (str) – Defines the allocation method for this IP address.

  • zones (list[str], Optional) – A collection containing the availability zone to allocate the Public IP in.

  • ddos_protection_mode (str, Optional) – The DDoS protection mode of the public IP.

  • ddos_protection_plan_id (str, Optional) – The ID of DDoS protection plan associated with the public IP.

  • domain_name_label (str, Optional) – Label for the Domain Name.

  • edge_zone (str, Optional) – Specifies the Edge Zone within the Azure Region where this Public IP should exist.

  • idle_timeout_in_minutes (int, Optional) – Specifies the timeout for the TCP idle connection.

  • ip_address (str, Optional) – The IP address associated with the public IP address resource.

  • ip_tags (dict, Optional) – A mapping of IP tags to assign to the public IP.

  • ip_version (str, Optional) – The IP Version to use.

  • public_ip_prefix_id (str, Optional) – If specified then public IP address allocated will be provided from the public IP prefix resource.

  • reverse_fqdn (str, Optional) – A fully qualified domain name that resolves to this public IP address.

  • migration_phase (str, Optional) – Migration phase of Public IP Address.

  • service_public_ip_address_id (str, Optional) – The service public IP address ID of the public IP address resource.

  • linked_public_ip_address_id (str, Optional) – The linked public IP address ID of the public IP address resource.

  • sku (str, Optional) – The SKU of the Public IP.

  • sku_tier (str, Optional) – The SKU Tier that should be used for the Public IP.

  • tags (dict, Optional) – Resource tags.

  • extended_location (Dict[str,str], Optional) –

    The extended location of the public ip address.

    • name(str, Optional):

      The name of the extended location.

    • type(str, Optional):

      The type of the extended location.

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

  • resource_id (str, Optional) – Management group resource id on Azure.

Returns:

dict

Examples

resource_is_present:
  azure.network.public_ip_addresses.present:
    - name: value
    - resource_group_name: value
    - public_ip_address_name: value
async idem_azure.states.azure.network.public_ip_addresses.absent(hub, ctx, name: str, resource_group_name: str = None, public_ip_address_name: str = None, subscription_id: str = None, resource_id: str = None) → dict[source]#

Delete Public IP Addresses.

Parameters:

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

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

  • public_ip_address_name (str, Optional) – The name of the public IP address.

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

  • resource_id (str, Optional) – Resource Group resource id in Azure.

Returns:

Dict

Examples

resource_is_absent:
  azure.network.public_ip_addresses.absent:
    - name: value
    - resource_group_name: value
    - public_ip_address_name: value
async idem_azure.states.azure.network.public_ip_addresses.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 Public IP Addresses under the same subscription.

Returns:

Dict[str, Any]

Examples

$ idem describe azure_auto.network.public_ip_addresses
idem_azure.states.azure.network.public_ip_addresses.is_pending(hub, ret: dict, state: str = None, **pending_kwargs) → bool[source]#

Default implemented for each module.