states.azurerm.postgresql.virtual_network_rule

Azure Resource Manager (ARM) PostgreSQL Virtual Network Rule Operations State Module

New in version 2.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 acct setup 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.postgresql.virtual_network_rule.absent(hub, ctx, name, server_name, resource_group, connection_auth=None, **kwargs)

New in version 2.0.0.

Ensures that the specified virtual network rule does not exist within the given PostgreSQL server.

Parameters:

• name – The name of the virtual network rule.
• server_name – The name of the server.
• resource_group – The name of the resource group. The name is case insensitive.
• connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.

Example usage:

Ensure vnet rule is absent:
    azurerm.postgresql.virtual_network_rule.absent:
        - name: my_rule
        - server_name: my_server
        - resource_group: my_rg

idem_azurerm.states.azurerm.postgresql.virtual_network_rule.present(hub, ctx, name, server_name, resource_group, subnet_id, ignore_missing_endpoint=None, connection_auth=None, **kwargs)

New in version 2.0.0.

Changed in version 4.0.0.

Ensures that the specified virtual network rule exists within the given PostgreSQL server.

Parameters:

• name – The name of the virtual network rule.
• server_name – The name of the server.
• resource_group – The name of the resource group. The name is case insensitive.
• subnet_id – The ARM Resource ID of the virtual network subnet. The ID will be in the following format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}’
• ignore_missing_endpoint – (Optional) A boolean value representing whether the firewall rule is created before the virtual network has the vnet service endpoint enabled.
• connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.

Example usage:

Ensure vnet rule exists:
    azurerm.postgresql.virtual_network_rule.present:
        - name: my_rule
        - server_name: my_server
        - resource_group: my_rg
        - subnet_id: my_id