azure_rm_sqldatabase – Manage SQL Database instance — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# azure_rm_sqldatabase – Manage SQL Database instance

New in version 2.5.

- Synopsis
- Requirements
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## Synopsis

- Create, update and delete instance of SQL Database.

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.7
- azure >= 2.0.0

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
ad_user string |  | Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 2.6 |  | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 2.5 | Default: "latest" | Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags boolean | Choices: no yes ← | 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.
auth_source string added in 2.5 | Choices: auto cli credential_file env msi | Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `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 `msi` was added in Ansible 2.6.
cert_validation_mode string added in 2.5 | Choices: ignore validate | 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 `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.
client_id string |  | Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4 | Default: "AzureCloud" | For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable.
collation - |  | The collation of the database. If create_mode is not `default`, this value is ignored.
create_mode - | Choices: copy default non_readable_secondary online_secondary point_in_time_restore recovery restore restore_long_term_retention_backup | Specifies the mode of database creation. `default`: regular database creation. `copy`: creates a database as a copy of an existing database. `online_secondary`/`non_readable_secondary`: creates a database as a (readable or nonreadable) secondary replica of an existing database. `point_in_time_restore`: Creates a database by restoring a point in time backup of an existing database. `recovery`: Creates a database by restoring a geo-replicated backup. `restore`: Creates a database by restoring a backup of a deleted database. `restore_long_term_retention_backup`: Creates a database by restoring from a long term retention vault. `copy`, `non_readable_secondary`, `online_secondary` and `restore_long_term_retention_backup` are not supported for `data_warehouse` edition.
edition - | Choices: web business basic standard premium free stretch data_warehouse system system2 | The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If create_mode is `non_readable_secondary` or `online_secondary`, this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: 'Capabilities_ListByLocation.'.
elastic_pool_name - |  | The name of the elastic pool the database is in. Not supported for `data_warehouse` edition.
force_update boolean | Choices: no yes | SQL Database will be updated if given parameters differ from existing resource state. To force SQL Database update in any circumstances set this parameter to True.
location - |  | Resource location. If not set, location from the resource group will be used as `default`.
max_size_bytes - |  | The max size of the database expressed in bytes. If create_mode is not `default`, this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: 'Capabilities_ListByLocation.'
name - / required |  | The name of the database to be operated on (updated or created).
password - |  | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string |  | Security profile found in ~/.azure/credentials file.
read_scale boolean | Choices: no ← yes | If the database is a geo-secondary, indicates whether read-only connections are allowed to this database or not. Not supported for `data_warehouse` edition.
recovery_services_recovery_point_resource_id - |  | Required if create_mode is `restore_long_term_retention_backup`, then this value is required. Specifies the resource ID of the recovery point to restore from.
resource_group - / required |  | The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
restore_point_in_time - |  | Required if create_mode is `point_in_time_restore`, this value is required. If create_mode is `restore`, this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database's earliestRestoreDate value.
sample_name - | Choices: adventure_works_lt | Indicates the name of the sample schema to apply when creating this database. If create_mode is not `default`, this value is ignored. Not supported for `data_warehouse` edition.
secret string |  | Azure client secret. Use when authenticating with a Service Principal.
server_name - / required |  | The name of the server.
source_database_deletion_date - |  | Required if create_mode is `restore` and source_database_id is the deleted database's original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted.
source_database_id - |  | Required unless create_mode is `default` or `restore_long_term_retention_backup`. Specifies the resource ID of the source database
state - | Choices: absent present ← | Assert the state of the SQL Database. Use `present` to create or update an SQL Database and `absent` to delete it.
subscription_id string |  | Your Azure subscription Id.
tags dictionary |  | 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.
tenant string |  | Azure tenant ID. Use when authenticating with a Service Principal.
zone_redundant boolean | Choices: no ← yes | Is this database is zone redundant? It means the replicas of this database will be spread across multiple availability zones.

## Notes

Note

- For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with `az login`.
- Authentication is also possible using a service principal or Active Directory user.
- To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
- To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
- Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

## See Also

See also

Sign in with Azure CLI
  How to authenticate using the `az login` command.

## Examples

    - name: Create (or update) SQL Database
      azure_rm_sqldatabase:
        resource_group: myResourceGroup
        server_name: sqlcrudtest-5961
        name: testdb
        location: eastus

    - name: Restore SQL Database
      azure_rm_sqldatabase:
        resource_group: myResourceGroup
        server_name: sqlcrudtest-5961
        name: restoreddb
        location: eastus
        create_mode: restore
        restorable_dropped_database_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/s
                                         ervers/testsvr/restorableDroppedDatabases/testdb2,131444841315030000"

    - name: Create SQL Database in Copy Mode
      azure_rm_sqldatabase:
        resource_group: myResourceGroup
        server_name: sqlcrudtest-5961
        name: copydb
        location: eastus
        create_mode: copy
        source_database_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/tests
                             vr/databases/testdb"

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
database_id string | always | The ID of the database. Sample: database_id
id string | always | Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb
status string | always | The status of the database. Sample: Online

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Zim Kalinowski (@zikalino)

Hint

If you notice any issues in this documentation you can edit this document to improve it.