Try SpotterGet Azure SQL Database facts
| "added in version" 2.8 of ansible.builtin"
Authors: Zim Kalinowski (@zikalino)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Get facts of Azure SQL Database.
- name: Get instance of SQL Database
azure_rm_sqldatabase_info:
resource_group: testrg
server_name: testserver
name: testdb
- name: List instances of SQL Database
azure_rm_sqldatabase_info:
resource_group: testrg
server_name: testserver
elastic_pool_name: testep
- name: List instances of SQL Database
azure_rm_sqldatabase_info:
resource_group: testrg
server_name: testserver
name:
description:
- The name of the database.
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
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
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.
type: str
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
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
server_name:
description:
- The name of the server.
required: true
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
subscription_id:
description:
- Your Azure subscription Id.
type: str
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
elastic_pool_name:
description:
- The name of the elastic pool.
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
databases:
contains:
collation:
description:
- The collation of the database.
returned: always
sample: SQL_Latin1_General_CP1_CI_AS
type: str
id:
description:
- Resource ID.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Sql/servers/testserver/databases/testdb
type: str
kind:
description:
- Kind of database. This is metadata used for the Azure portal experience.
returned: always
sample: v12.0,user
type: str
location:
description:
- Resource location.
returned: always
sample: southeastasia
type: str
name:
description:
- Database name.
returned: always
sample: testdb
type: str
sku:
contains:
capacity:
description:
- The SKU capacity.
returned: always
sample: 2
type: int
name:
description:
- The name of the SKU.
returned: always
sample: BC_Gen4_2
type: str
tier:
description:
- The SKU tier.
returned: always
sample: BusinessCritical
type: str
description:
- The name and tier of the SKU.
returned: always
type: complex
status:
description:
- The status of the database.
returned: always
sample: Online
type: str
tags:
description:
- Resource tags.
returned: always
sample:
taga: aaa
tagb: bbb
type: dict
zone_redundant:
description:
- Whether or not this database is zone redundant, which means the replicas of
this database will be spread across multiple availability zones.
returned: always
sample: true
type: bool
description:
- A list of dictionaries containing facts for SQL Database.
returned: always
type: complex