states.azurerm.network.network_profile

Azure Resource Manager (ARM) Network Profile State Module

New in version 3.0.0.

Changed in version 4.0.0.

maintainer:

<devops@eitr.tech>

configuration:

This module requires Azure Resource Manager credentials to be passed via acct. Note that the authentication parameters are case sensitive.

Required provider parameters:

if using username and password:

• subscription_id
• username
• password

if using a service principal:

• subscription_id
• tenant
• client_id
• secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

• AZURE_PUBLIC_CLOUD (default)
• AZURE_CHINA_CLOUD
• AZURE_US_GOV_CLOUD
• AZURE_GERMAN_CLOUD

Example configuration for Azure Resource Manager authentication:

azurerm:
    default:
        subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
        tenant: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        client_id: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        secret: XXXXXXXXXXXXXXXXXXXXXXXX
        cloud_environment: AZURE_PUBLIC_CLOUD
    user_pass_auth:
        subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
        username: fletch
        password: 123pass

The authentication parameters can also be passed as a dictionary of keyword arguments to the connection_auth parameter of each state, but this is not preferred and could be deprecated in the future.

idem_azurerm.states.azurerm.network.network_profile.absent(hub, ctx, name, resource_group, connection_auth=None, **kwargs)

New in version 3.0.0.

Ensure a network profile does not exist in a resource group.

Parameters:

• name – Name of the network profile.
• resource_group – The name of the resource group to which the network profile belongs.

Ensure network profile is absent:
    azurerm.network.network_profile.absent:
        - name: aci-network-profile
        - resource_group: testgroup

idem_azurerm.states.azurerm.network.network_profile.present(hub, ctx, name, resource_group, container_network_interfaces=None, container_network_interface_configurations=None, tags=None, connection_auth=None, **kwargs)

New in version 3.0.0.

Changed in version 4.0.0.

Ensure a network profile exists.

Parameters:

• name – The name of the network profile.
• resource_group – The name of the resource group to which the network profile belongs.
• container_network_interfaces – List of child container network interfaces.
• container_network_interface_configurations – List of child container network interface configurations.
• tags – A dictionary of strings can be passed as tag metadata to the object.

Example usage:

Ensure network profile exists:
    azurerm.network.network_profile.present:
        - name: aci-network-profile
        - resource_group: testgroup
        - container_network_interface_configurations:
            - name: eth0
              ip_configurations:
                - name: ipconfigprofile
                  subnet:
                      id: {{ subnet_resource_id }}
        - tags:
            how_awesome: very
            contact_name: Elmer Fudd Gantry