exec.azurerm.postgresql.server

Azure Resource Manager (ARM) PostgreSQL Server 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.server.create(hub, ctx, name, resource_group, location, sku=None, version=None, ssl_enforcement=None, minimal_tls_version=None, infrastructure_encryption=None, public_network_access=None, storage_profile=None, login=None, login_password=None, tags=None, **kwargs)

New in version 2.0.0.

Changed in version 4.0.0.

Creates a new server, or will overwrite an existing server.

Parameters:
  • name – The name of the server.
  • resource_group – The name of the resource group. The name is case insensitive.
  • location – The location the resource resides in.
  • sku – The name of the SKU (pricing tier) of the server. Typically, the name of the sku is in the form tier_family_cores, e.g. B_Gen4_1, GP_Gen5_8.
  • version – Server version. Possible values include: “9.5”, “9.6”, “10”, “10.0”, “10.2”, “11”.
  • ssl_enforcement – Enable ssl enforcement or not when connect to server. Possible values include: “Enabled”, “Disabled”.
  • minimal_tls_version – Enforce a minimal tls version for the server. Possible values include: “TLS1_0”, “TLS1_1”, “TLS1_2”, “TLSEnforcementDisabled”.
  • infrastructure_encryption – Status showing whether the server enabled infrastructure encryption. Possible values include: “Enabled”, “Disabled”.
  • public_network_access – Whether or not public network access is allowed for this server. Possible values include: “Enabled”, “Disabled”.
  • storage_profile

    A dictionary representing the storage profile of a server. Parameters include:

    • backup_retention_days: Backup retention days for the server.
    • geo_redundant_backup: Enable Geo-redundant or not for server backup. Possible values include: ‘Enabled’, ‘Disabled’.
    • storage_mb: Max storage allowed for a server.
    • storage_autogrow: Enable Storage Auto Grow. Possible values include: ‘Enabled’, ‘Disabled’.
  • login – The administrator’s login name of a server. This value is immutable once set.
  • login_password – The password of the administrator login.
  • tags – Application-specific metadata in the form of key-value pairs.

CLI Example:

azurerm.postgresql.server.create test_name test_group test_location test_sku
idem_azurerm.exec.azurerm.postgresql.server.delete(hub, ctx, name, resource_group, **kwargs)

New in version 2.0.0.

Deletes a server.

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

CLI Example:

azurerm.postgresql.server.delete test_name test_group
idem_azurerm.exec.azurerm.postgresql.server.get(hub, ctx, name, resource_group, **kwargs)

New in version 2.0.0.

Gets information about a server.

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

CLI Example:

azurerm.postgresql.server.get test_name test_group
idem_azurerm.exec.azurerm.postgresql.server.list_(hub, ctx, resource_group=None, **kwargs)

New in version 2.0.0.

Changed in version 4.0.0.

List all the servers in a given subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.postgresql.server.list
idem_azurerm.exec.azurerm.postgresql.server.restart(hub, ctx, name, resource_group, **kwargs)

New in version 2.0.0.

Restarts a server.

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

CLI Example:

azurerm.postgresql.server.restart test_name test_group
idem_azurerm.exec.azurerm.postgresql.server.update(hub, ctx, name, resource_group, sku=None, version=None, ssl_enforcement=None, minimal_tls_version=None, infrastructure_encryption=None, public_network_access=None, storage_profile=None, login_password=None, tags=None, **kwargs)

New in version 2.0.0.

Changed in version 4.0.0.

Creates a new server, or will overwrite an existing server.

Parameters:
  • name – The name of the server.
  • resource_group – The name of the resource group. The name is case insensitive.
  • sku – The name of the SKU (pricing tier) of the server. The name of the sku is in the form tier_family_cores, e.g. B_Gen4_1, GP_Gen5_8.
  • version – Server version. Possible values include: “9.5”, “9.6”, “10”, “10.0”, “10.2”, “11”.
  • ssl_enforcement – Enable ssl enforcement or not when connect to server. Possible values include: “Enabled”, “Disabled”.
  • minimal_tls_version – Enforce a minimal tls version for the server. Possible values include: “TLS1_0”, “TLS1_1”, “TLS1_2”, “TLSEnforcementDisabled”.
  • infrastructure_encryption – Status showing whether the server enabled infrastructure encryption. Possible values include: “Enabled”, “Disabled”.
  • public_network_access – Whether or not public network access is allowed for this server. Possible values include: “Enabled”, “Disabled”.
  • storage_profile

    A dictionary representing the storage profile of a server. Parameters include:

    • backup_retention_days: Backup retention days for the server.
    • geo_redundant_backup: Enable Geo-redundant or not for server backup. Possible values include: ‘Enabled’, ‘Disabled’.
    • storage_mb: Max storage allowed for a server.
    • storage_autogrow: Enable Storage Auto Grow. Possible values include: ‘Enabled’, ‘Disabled’.
  • login_password – The password of the administrator login.
  • tags – Application-specific metadata in the form of key-value pairs.

CLI Example:

azurerm.postgresql.server.update test_name test_group test_updated_params