azure.azcollection.azure_rm_sqlmidblongtermretentionpolicy_info module – Get Azure SQL managed instance facts
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_sqlmidblongtermretentionpolicy_info
.
New in azure.azcollection 2.4.0
Synopsis
Get facts of Azure SQL managed instance facts.
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: |
|
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 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:
|
|
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. |
|
The name of the SQL managed instance short term retention policy. Choices:
|
|
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. |
|
Your Azure subscription Id. |
|
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: Get SQL managed instance long term retention policy by name
azure_rm_sqlmidblongtermretentionpolicy_info:
resource_group: testrg
managed_instance_name: testinstancename
database_name: newdatabase
policy_name: default
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 Short Term Retention Policies. Returned: always |
|
SQL managed instance database name. Returned: always Sample: |
|
Resource ID. Returned: always Sample: |
|
SQL managed instance name. Returned: always Sample: |
|
The monthly retention policy for an LTR backup in an ISO 8601 format. Returned: always Sample: |
|
SQL managed instance short term retentioni policy name. Returned: always Sample: |
|
The resource relate resource group. Returned: always Sample: |
|
The SQL managed instance short term retention policy type. Returned: always Sample: |
|
The week of year to take the yearly backup in an ISO 8601 format. Returned: always Sample: |
|
The weekly retention policy for an LTR backup in an ISO 8601 format. Returned: always Sample: |
|
The yearly retention policy for an LTR backup in an ISO 8601 format. Returned: always Sample: |