New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
ad_user | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
adfs_authority_url (added in 2.6) | Default: None | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
api_profile (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. |
auth_source (added in 2.5) |
| 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 (added in 2.5) |
| 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 | Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment (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. |
name | The name of the server. | |
password | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
profile | Security profile found in ~/.azure/credentials file. | |
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. | |
secret | Azure client secret. Use when authenticating with a Service Principal. | |
subscription_id | Your Azure subscription Id. | |
tags | Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
tenant | Azure tenant ID. Use when authenticating with a Service Principal. |
Note
- name: Get instance of MySQL Server azure_rm_mysqlserver_facts: resource_group: resource_group_name name: server_name - name: List instances of MySQL Server azure_rm_mysqlserver_facts: resource_group: resource_group_name
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
servers complex | always | A list of dictionaries containing facts for MySQL servers. | ||
sku complex | always | The SKU of the server. | ||
tier str | always | The tier of the particular SKU Sample: GeneralPurpose | ||
capacity int | always | The scale capacity. Sample: 2 | ||
name str | always | The name of the SKU Sample: GP_Gen4_2 | ||
version str | always | Server version. Sample: 9.6 | ||
name str | always | Resource name. Sample: myabdud1223 | ||
user_visible_state str | always | A state of a server that is visible to user. Sample: Ready | ||
fully_qualified_domain_name str | always | The fully qualified domain name of a server. Sample: myabdud1223.mys.database.azure.com | ||
id str | always | Resource ID Sample: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/myabdud1223 | ||
location str | always | The location the resource resides in. Sample: eastus |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_mysqlserver_facts_module.html