azure / azure.azcollection / 2.3.0 / module / azure_rm_postgresqlserver Manage PostgreSQL Server instance | "added in version" 0.1.2 of azure.azcollection" Authors: Zim Kalinowski (@zikalino)azure.azcollection.azure_rm_postgresqlserver (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, update and delete instance of PostgreSQL Server.
- name: Create (or update) PostgreSQL Server azure_rm_postgresqlserver: resource_group: myResourceGroup name: testserver sku: name: B_Gen5_1 tier: Basic location: eastus storage_mb: 1024 enforce_ssl: true storage_autogrow: true admin_username: cloudsa admin_password: password
sku: description: - The SKU (pricing tier) of the server. suboptions: capacity: description: - The scale up/out capacity, representing server's compute units. name: description: - The name of the SKU, typically, tier + family + cores, for example C(B_Gen4_1), C(GP_Gen5_8). size: description: - The size code, to be interpreted by resource as appropriate. tier: choices: - Basic - Standard description: - The tier of the particular SKU, for example C(Basic). type: dict name: description: - The name of the server. required: true type: str tags: description: - Dictionary of string:string pairs to assign as metadata to the object. - Metadata tags on the object will be updated with any provided values. - To remove tags set append_tags option to false. - Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. - Azure Front Door doesn't support the use of - Azure Automation and Azure CDN only support 15 tags on resources. type: dict state: choices: - present - absent default: present description: - Assert the state of the PostgreSQL server. Use C(present) to create or update a server and C(absent) to delete it. type: str secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str version: choices: - '9.5' - '9.6' - '10' - '11' description: - Server version. type: str location: description: - Resource location. If not set, location from the resource group will be used as default. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str storage_mb: description: - The maximum storage allowed for a server. type: int thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - Use to control if tags field is canonical or just appends to existing tags. - When canonical, any tags not found in the tags parameter will be removed from the object's metadata. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. - When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. - The C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection create_mode: choices: - default - geo_restore - point_in_time_restore default: default description: - Create mode of SQL Server. Blank (default), restore from geo redundant (geo_restore), or restore from point in time (point_in_time_restore). type: str enforce_ssl: default: false description: - Enable SSL enforcement. type: bool admin_password: description: - The password of the administrator login. type: str admin_username: description: - The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). type: str resource_group: description: - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. required: true type: str subscription_id: description: - Your Azure subscription Id. type: str source_server_id: description: - Id if the source server if I(create_mode=default). type: str storage_autogrow: default: false description: - Enable storage autogrow. type: bool cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection geo_redundant_backup: default: false description: - Choose between locally redundant(default) or geo-redundant backup. This cannot be updated after first deployment type: bool backup_retention_days: description: - Backup retention period between 7 and 35 days. 7 days by default if not set type: int restore_point_in_time: description: - Restore point creation time (ISO8601 format), specifying the time to restore from. - Required if I(create_mode=point_in_time_restore). type: str x509_certificate_path: description: - Path to the X509 certificate used to create the service principal in PEM format. - The certificate must be appended to the private key. - Use when authenticating with a Service Principal. type: path version_added: 1.14.0 version_added_collection: azure.azcollection disable_instance_discovery: default: false description: - Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. - Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection
fully_qualified_domain_name: description: - The fully qualified domain name of a server. returned: always sample: postgresqlsrv1b6dd89593.postgresql.database.azure.com type: str id: description: - Resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593 type: str state: description: - A state of a server that is visible to user. Possible values include C(Ready), C(Dropping), C(Disabled). returned: always sample: Ready type: str version: description: - Server version. Possible values include C(9.5), C(9.6), C(10), C(11). returned: always sample: 9.6 type: str