community.azure.azure_rm_mysqlserver_facts (0.1.0) — module

Get Azure MySQL Server facts

Authors: Zim Kalinowski (@zikalino)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.azure:==0.1.0


Add to requirements.yml

  collections:
    - name: community.azure
      version: 0.1.0

Description

Get facts of MySQL Server.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get instance of MySQL Server
    azure_rm_mysqlserver_info:
      resource_group: myResourceGroup
      name: server_name
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: List instances of MySQL Server
    azure_rm_mysqlserver_info:
      resource_group: myResourceGroup

Inputs

    
name:
    description:
    - The name of the server.
    type: str

tags:
    description:
    - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
    type: list

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: '2.5'
    version_added_collection: azure.azcollection

auth_source:
    choices:
    - auto
    - cli
    - credential_file
    - env
    - msi
    description:
    - 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 C(auto) if variable is not defined.
    - C(auto) will follow the default precedence of module parameters -> environment variables
      -> default profile in credential file C(~/.azure/credentials).
    - When set to C(cli), the credentials will be sources from the default Azure CLI profile.
    - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
    - 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: '2.5'
    version_added_collection: azure.azcollection

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
    type: str

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: '2.4'
    version_added_collection: azure.azcollection

adfs_authority_url:
    description:
    - Azure AD authority url. Use when authenticating with Username/password, and has
      your own ADFS authority.
    type: str
    version_added: '2.6'
    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: '2.5'
    version_added_collection: azure.azcollection

Outputs

servers:
  contains:
    admin_username:
      description:
      - The administrator's login name of a server.
      returned: always
      sample: serveradmin
      type: str
    enforce_ssl:
      description:
      - Enable SSL enforcement.
      returned: always
      sample: false
      type: bool
    fully_qualified_domain_name:
      description:
      - The fully qualified domain name of a server.
      returned: always
      sample: myabdud1223.mys.database.azure.com
      type: str
    id:
      description:
      - Resource ID.
      returned: always
      sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/myabdud1223
      type: str
    location:
      description:
      - The location the resource resides in.
      returned: always
      sample: eastus
      type: str
    name:
      description:
      - Resource name.
      returned: always
      sample: myabdud1223
      type: str
    resource_group:
      description:
      - Resource group name.
      returned: always
      sample: myResourceGroup
      type: str
    sku:
      contains:
        capacity:
          description:
          - The scale capacity.
          returned: always
          sample: 2
          type: int
        name:
          description:
          - The name of the SKU.
          returned: always
          sample: GP_Gen4_2
          type: str
        tier:
          description:
          - The tier of the particular SKU.
          returned: always
          sample: GeneralPurpose
          type: str
      description:
      - The SKU of the server.
      returned: always
      type: complex
    storage_mb:
      description:
      - The maximum storage allowed for a server.
      returned: always
      sample: 128000
      type: int
    tags:
      description:
      - Tags assigned to the resource. Dictionary of string:string pairs.
      sample:
        tag1: abc
      type: dict
    user_visible_state:
      description:
      - A state of a server that is visible to user.
      returned: always
      sample: Ready
      type: str
    version:
      description:
      - Server version.
      returned: always
      sample: '9.6'
      type: str
  description:
  - A list of dictionaries containing facts for MySQL servers.
  returned: always
  type: complex

See also