exec.azurerm.postgresql.database¶
Azure Resource Manager (ARM) PostgreSQL Database Operations Execution Module
New in version 2.0.0.
maintainer: | |
---|---|
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:
Optional provider parameters: cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:
|
-
idem_azurerm.exec.azurerm.postgresql.database.
create_or_update
(hub, ctx, name, server_name, resource_group, charset=None, collation=None, **kwargs)¶ New in version 2.0.0.
Creates a new database or updates an existing database.
Parameters: - name – The name of the database.
- server_name – The name of the server.
- resource_group – The name of the resource group. The name is case insensitive.
- charset – The charset of the database. Defaults to None.
- collation – The collation of the database. Defaults to None.
CLI Example:
azurerm.postgresql.database.create_or_update test_name test_server test_group test_charset test_collation
-
idem_azurerm.exec.azurerm.postgresql.database.
delete
(hub, ctx, name, server_name, resource_group, **kwargs)¶ New in version 2.0.0.
Deletes a database.
Parameters: - name – The name of the database.
- server_name – The name of the server.
- resource_group – The name of the resource group. The name is case insensitive.
CLI Example:
azurerm.postgresql.database.delete test_name test_server test_group
-
idem_azurerm.exec.azurerm.postgresql.database.
get
(hub, ctx, name, server_name, resource_group, **kwargs)¶ New in version 2.0.0.
Gets information about a database.
Parameters: - name – The name of the database.
- server_name – The name of the server.
- resource_group – The name of the resource group. The name is case insensitive.
CLI Example:
azurerm.postgresql.database.get test_name test_server test_group
-
idem_azurerm.exec.azurerm.postgresql.database.
list_by_server
(hub, ctx, server_name, resource_group, **kwargs)¶ New in version 2.0.0.
List all the databases 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.database.list_by_server test_server test_group