azure_rm_sqldatabase

Manage SQL Database instance

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_sqldatabase

Synopsis

Manage SQL Database instance

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string		`latest`	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.
append_tags	bool		`true`	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		`auto`	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.
cert_validation_mode	string			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.
client_id	string			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.
cloud_environment	string		`AzureCloud`	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.
collation	string			The collation of the database. If not I(create_mode=default), this value is ignored.
create_mode	string			Specifies the mode of database creation.
C(default), regular database creation.
C(copy), creates a database as a copy of an existing database.
C(online_secondary)/C(non_readable_secondary), creates a database as a (readable or nonreadable) secondary replica of an existing database.
C(point_in_time_restore), Creates a database by restoring a point in time backup of an existing database.
C(recovery), Creates a database by restoring a geo-replicated backup.
C(restore), Creates a database by restoring a backup of a deleted database.
C(restore_long_term_retention_backup), Creates a database by restoring from a long term retention vault.
C(copy), C(non_readable_secondary), C(online_secondary) and C(restore_long_term_retention_backup) are not supported for C(data_warehouse) edition.
disable_instance_discovery	bool		`false`	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.
edition	string			(Deprecate)The edition of the database. The DatabaseEditions enumeration contains all the valid editions.
This option will be deprecated in 2.11, use I(sku) instead.
Cannot set C(sku) when this field set.
elastic_pool_name	string			The name of the elastic pool the database is in. Not supported for I(edition=data_warehouse).
force_update	bool			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	string			Resource location. If not set, location from the resource group will be used as default.
log_mode	string			Parent argument.
log_path	string			Parent argument.
max_size_bytes	string			The max size of the database expressed in bytes.
If not I(create_mode=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	string	yes		The name of the database to be operated on (updated or created).
oidc_token	string			Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
password	string			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	bool		`false`	If the database is a geo-secondary, indicates whether read-only connections are allowed to this database or not.
Not supported for I(edition=data_warehouse).
recovery_services_recovery_point_resource_id	string			Required if I(create_mode=restore_long_term_retention_backup), then this value is required.
Specifies the resource ID of the recovery point to restore from.
resource_group	string	yes		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	string			Required if I(create_mode=point_in_time_restore), this value is required. If I(create_mode=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	string			Indicates the name of the sample schema to apply when creating this database.
If not I(create_mode=default), this value is ignored.
Not supported for I(edition=data_warehouse).
secret	string			Azure client secret. Use when authenticating with a Service Principal.
server_name	string	yes		The name of the server.
sku	dict			The sku of the database. The DatabaseEditions enumeration contains all the valid sku.
If I(create_mode=non_readable_secondary) or I(create_mode=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’.
Cannot set C(edition) when this field set.
source_database_deletion_date	string			Required if I(create_mode=restore) and I(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	string			Required unless I(create_mode=default) or I(create_mode=restore_long_term_retention_backup).
Specifies the resource ID of the source database.
state	string		`present`	Assert the state of the SQL Database. Use C(present) to create or update an SQL Database and C(absent) to delete it.
subscription_id	string			Your Azure subscription Id.
tags	dict			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.
tenant	string			Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint	string			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.
x509_certificate_path	string			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.
zone_redundant	bool		`false`	Is this database is zone redundant? It means the replicas of this database will be spread across multiple availability zones.

Example

yaml

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

- name: Restore SQL Database
  azure.azcollection.azure_rm_sqldatabase:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: restoreddb
    location: eastus
    create_mode: restore
    source_database_deletion_date: '2024-07-26T17:50:01Z'

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

- name: Create (or update) SQL Database with SKU
  azure.azcollection.azure_rm_sqldatabase:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: testdb
    location: eastus
    sku:
      name: S0