azure_rm_mariadbserver_facts – Get Azure MariaDB Server facts
azure_rm_mariadbserver_facts – Get Azure MariaDB Server facts
New in version 2.8.
Synopsis
- Get facts of MariaDB Server.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
ad_user string |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
adfs_authority_url string added in 2.6 |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | |
api_profile string added in 2.5 |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
auth_source string 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
When set to Can also be set via the When set to The |
cert_validation_mode string 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 |
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment string 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, |
name - |
The name of the server. | |
password - |
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. | |
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 string |
Azure client secret. Use when authenticating with a Service Principal. | |
subscription_id string |
Your Azure subscription Id. | |
tags - |
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
tenant string |
Azure tenant ID. 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
Examples
- name: Get instance of MariaDB Server
azure_rm_mariadbserver_facts:
resource_group: myResourceGroup
name: server_name
- name: List instances of MariaDB Server
azure_rm_mariadbserver_facts:
resource_group: myResourceGroup
Return Values
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 MariaDB servers.
| ||
admin_username string |
always |
The administrator's login name of a server.
Sample: serveradmin | ||
enforce_ssl boolean |
always |
Enable SSL enforcement.
| ||
fully_qualified_domain_name string |
always |
The fully qualified domain name of a server.
Sample: myabdud1223.mys.database.azure.com | ||
id string |
always |
Resource ID
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMariaDB/servers/myabdud1223 | ||
location string |
always |
The location the resource resides in.
Sample: eastus | ||
name string |
always |
Resource name.
Sample: myabdud1223 | ||
resource_group string |
always |
Resource group name.
Sample: myResourceGroup | ||
sku complex |
always |
The SKU of the server.
| ||
capacity integer |
always |
The scale capacity.
Sample: 2 | ||
name string |
always |
The name of the SKU
Sample: GP_Gen4_2 | ||
tier string |
always |
The tier of the particular SKU
Sample: GeneralPurpose | ||
storage_mb integer |
always |
The maximum storage allowed for a server.
Sample: 128000 | ||
tags dictionary |
Tags assigned to the resource. Dictionary of string:string pairs.
Sample: {'tag1': 'abc'} | |||
user_visible_state string |
always |
A state of a server that is visible to user.
Sample: Ready | ||
version string |
always |
Server version.
Sample: 9.6 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Zim Kalinowski (@zikalino)
- Matti Ranta (@techknowlogick)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_mariadbserver_facts_module.html