azure.azcollection.azure_rm_sqlmidatabase module – Manage SQL Managed Instance databases
Note
This module is part of the azure.azcollection collection (version 2.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install azure.azcollection
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_sqlmidatabase
.
New in azure.azcollection 2.4.0
Synopsis
Manage SQL Managed Instance databases.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
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. Choices:
|
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
The collation of the Azure SQL Managed Database collation to use. For example |
|
The name of the SQL managed instance database. |
|
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 Choices:
|
|
The resource location. |
|
Parent argument. |
|
Parent argument. |
|
The name of the SQL managed instance. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group that contains the resource. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
State of the SQL Managed Database. Use Choices:
|
|
Your Azure subscription Id. |
|
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. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
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. |
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 a SQL managed instance database
azure_rm_sqlmidatabase:
resource_group: testrg
managed_instance_name: testinstancename
database_name: newdatabase
collation: SQL_Latin1_General_CP1_CI_AS
location: eastus
tags:
key2: value2
- name: Delete the SQL managed instance database
azure_rm_sqlmidatabase:
resource_group: testrg
managed_instance_name: testinstancename
database_name: newdatabase
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary containing facts for SQL Managed Instance database info. Returned: always |
|
Whether to auto complete restore of this managed database. Returned: always |
|
Collation of the metadata catalog. Returned: always |
|
Creation date of the database. Returned: always Sample: |
|
Managed database create mode. Returned: always |
|
The sql mi databse name. Returned: always Sample: |
|
Geo paired region. Returned: always Sample: |
|
The resource ID. Returned: always Sample: |
|
Last backup file name for restore of this managed database. Returned: always |
|
The resource’s location. Returned: always Sample: |
|
The name of the Long Term Retention backup to be used for restore of this managed database. Returned: always |
|
The name of the SQL managed instance. Returned: always Sample: |
|
The resource identifier of the recoverable database associated with the database. Returned: always |
|
The resource’s resource group. Returned: always Sample: |
|
The restorable dropped database resource id. Returned: always |
|
Specifies the point in time (ISO8601 format) of the source database. Returned: always |
|
The resource identifier of the source database associated with create operation of this database. Returned: always |
|
Status of the database. Returned: always Sample: |
|
Specifies the storage container sas token. Returned: always |
|
Specifies the uri of the storage container where backups for this restore are stopped. Returned: always |
|
The resource’s tags Returned: always Sample: |
|
The resource type. Returned: always Sample: |