Azure Resource Manager (ARM) PostgreSQL Server Configuration Operations State Module

New in version 2.0.0.

Changed in version 4.0.0.




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)

Example acct setup for Azure Resource Manager authentication:

        subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
        tenant: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        client_id: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        cloud_environment: AZURE_PUBLIC_CLOUD
        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.configuration.present(hub, ctx, name, server_name, resource_group, value, connection_auth=None, **kwargs)

New in version 2.0.0.

Changed in version 4.0.0.

Ensures that a specific configuration setting exists with the given value for a specific PostgreSQL server. A list of configuration settings that can be updated for the given server can be found by using the list_by_server operation below. Additionally, all possible values for each individual configuration setting can be found using that module.

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

Example usage:

Ensure configuration setting exists:
        - name: my_rule
        - server_name: my_server
        - resource_group: my_rg
        - value: config_value