exec.azurerm.postgresql.configuration

Azure Resource Manager (ARM) PostgreSQL Server Configuration Operations Execution 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 as keyword arguments to every function or via acct in order to work properly.

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
idem_azurerm.exec.azurerm.postgresql.configuration.create_or_update(hub, ctx, name, server_name, resource_group, value, **kwargs)

New in version 2.0.0.

Changed in version 4.0.0.

Updates the specified configuration setting for the given 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.

Parameters:
  • name – The name of the server configuration setting to update.
  • 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.

CLI Example:

azurerm.postgresql.configuration.create_or_update test_name test_server test_group test_value
idem_azurerm.exec.azurerm.postgresql.configuration.get(hub, ctx, name, server_name, resource_group, **kwargs)

New in version 2.0.0.

Gets information about a configuration setting for the specified server.

Parameters:
  • 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.

CLI Example:

azurerm.postgresql.configuration.get test_name test_server test_group
idem_azurerm.exec.azurerm.postgresql.configuration.list_by_server(hub, ctx, server_name, resource_group, **kwargs)

New in version 2.0.0.

List all the configuration settings in a given server.

Parameters:
  • server_name – The name of the server.
  • resource_group – The name of the resource group. The name is case insensitive.

CLI Example:

azurerm.postgresql.configuration.list_by_server test_server test_group