azure.azcollection.azure_rm_mysqlflexibleserver_info 模块 – 获取 Azure MySQL 灵活服务器信息

注意

此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在剧本中使用它，请指定：azure.azcollection.azure_rm_mysqlflexibleserver_info。

azure.azcollection 2.6.0 中的新增功能

概要

  • 获取 MySQL 灵活服务器的信息。

要求

执行此模块的主机需要满足以下要求。

  • python >= 2.7

  • 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

  • 必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装集合的 requirements.txt 中列出的所有 python 包

  • 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到

参数

参数

注释

ad_user

字符串

Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。

adfs_authority_url

字符串

在 azure.azcollection 0.0.1 中添加

Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且有自己的 ADFS 授权时使用。

api_profile

字符串

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时使用的 API 配置文件。默认值 latest 适用于公有云；未来的值将允许与 Azure Stack 一起使用。

默认值： "latest"

auth_source

字符串

在 azure.azcollection 0.0.1 中添加

控制用于身份验证的凭据的来源。

也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。

当设置为 auto（默认值）时，优先级为模块参数 -> env -> credential_file -> cli。

当设置为 env 时，凭据将从环境变量中读取

当设置为 credential_file 时，它将从 ~/.azure/credentials 读取配置文件。

当设置为 cli 时，凭据将来自 Azure CLI 配置文件。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果存在多个），否则使用默认的 az cli 订阅。

当设置为 msi 时，主机必须是启用 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果资源被授予对多个订阅的访问权限），否则将选择第一个订阅。

msi 在 Ansible 2.6 中添加。

选择

  • "auto" ←（默认）

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

字符串

在 azure.azcollection 0.0.1 中添加

控制 Azure 端点的证书验证行为。默认情况下，所有模块都会验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。

选择

  • "ignore"

  • "validate"

client_id

字符串

Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量设置。

cloud_environment

字符串

在 azure.azcollection 0.0.1 中添加

对于美国公共云之外的云环境，环境名称（由 Azure Python SDK 定义，例如，AzureChinaCloud，AzureUSGovernment），或元数据发现端点 URL（Azure Stack 所必需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。

默认值： "AzureCloud"

disable_instance_discovery

布尔值

在 azure.azcollection 2.3.0 中添加

确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点（例如在私有云或 Azure Stack 中）的场景。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将其设置为 **True**，将禁用授权验证。因此，必须确保配置的授权主机有效且可信。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。

选择

  • false ← (默认)

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

服务器的名称。

password

字符串

Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

字符串

在 ~/.azure/credentials 文件中找到的安全配置文件。

resource_group

字符串

包含资源的资源组的名称。您可以从 Azure Resource Manager API 或门户获取此值。

secret

字符串

Azure 客户端密钥。当使用服务主体进行身份验证时使用。

subscription_id

字符串

您的 Azure 订阅 ID。

tags

list / elements=string

通过提供标签列表来限制结果。将标签格式化为 ‘key’ 或 ‘key:value’。

tenant

字符串

Azure 租户 ID。当使用服务主体进行身份验证时使用。

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

当使用服务主体进行身份验证时使用。

如果定义了 x509_certificate_path，则为必需项。

x509_certificate_path

path

在 azure.azcollection 1.14.0 中添加

用于创建 PEM 格式的服务主体的 X509 证书的路径。

证书必须附加到私钥。

当使用服务主体进行身份验证时使用。

注释

注意

  • 要使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行您的任务或 playbook 之前使用 az login 登录。

  • 也可以使用服务主体或 Active Directory 用户进行身份验证。

  • 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

  • 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和 password，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

  • 或者，凭据可以存储在 ~/.azure/credentials 中。这是一个 ini 文件，包含 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。还可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

参见

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Get instance of MySQL Flexible Server
  azure_rm_mysqlflexibleserver_info:
    resource_group: myResourceGroup
    name: server_name

- name: List instances of MySQL Flexible Server and filter by tags
  azure_rm_mysqlflexibleserver_info:
    resource_group: myResourceGroup

- name: List instances of MySQL Flexible Server
  azure_rm_mysqlflexibleserver_info:
    resource_group: myResourceGroup
    tags:
      - key

返回值

常见的返回值记录在这里，以下是此模块特有的字段

Key

描述

servers

complex

包含 MySQL 服务器信息的字典列表。

返回值: 始终

administrator_login

字符串

服务器的管理员登录名。

返回值: 始终

示例: "serveradmin"

availability_zone

字符串

服务器的可用区信息。

返回值: 始终

示例: "1"

backup

complex

服务器的备份相关属性。

返回值: 始终

backup_retention_days

integer

服务器的备份保留天数。

返回值: 始终

示例: 7

geo_redundant_backup

字符串

是否启用异地冗余备份。

返回值: 始终

示例: "Disabled"

fully_qualified_domain_name

字符串

服务器的完全限定域名。

返回值: 始终

示例: "myabdud1223.mys.database.azure.com"

high_availability

complex

服务器的高可用性相关属性。

返回值: 始终

mode

字符串

服务器的高可用性模式。

返回值: 始终

示例: "Disabled"

standby_availability_zone

字符串

备用服务器的可用区。

返回值: 始终

示例: "备用服务器的可用区"

id

字符串

资源 ID。

返回值: 始终

示例: "/subscriptions/xxxx-xxxx/resourceGroups/testRG/providers/Microsoft.DBforMySQL/flexibleServers/server01"

location

字符串

资源所在的地理位置。

返回值: 始终

示例: "eastus"

name

字符串

资源名称。

返回值: 始终

示例: "server01"

network

complex

服务器的网络相关属性。

返回值: 始终

delegated_subnet_resource_id

字符串

用于为服务器设置 vnet 的委派子网资源 id。

返回值: 始终

private_dns_zone_resource_id

字符串

私有 DNS 区域资源 id。

返回值: 始终

resource_group

字符串

资源组名称。

返回值: 始终

示例: "testRG"

restore_point_in_time

字符串

还原点创建时间（ISO8601 格式），指定要还原的时间。

返回值: 始终

sku

complex

服务器的 SKU。

返回值: 始终

name

字符串

SKU 的名称。

返回值: 始终

示例: "Standard_D32s_v3"

tier

字符串

特定 SKU 的层级。

返回值: 始终

示例: "GeneralPurpose"

source_server_resource_id

字符串

源 MySQL 服务器 id。

返回值: 始终

state

字符串

用户可见的服务器状态。

返回值: 始终

示例: "Ready"

storage

complex

服务器的存储相关属性。

返回值: 始终

auto_grow

字符串

是否启用存储自动增长。

返回值: 始终

示例: "Disabled"

iops

integer

服务器的存储 IOPS。

返回值: 始终

示例: 684

storage_size_gb

integer

服务器允许的最大存储大小。

返回值: 始终

示例: 128000

tags

dictionary

分配给资源的标签。字符串:字符串对的字典。

返回值: 始终

示例: {"tag1": "abc"}

type

字符串

资源的类型。

返回值: 始终

示例: "Microsoft.DBforMySQL/flexibleServers"

version

字符串

服务器版本。

返回值: 始终

示例: "5.7"

作者

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)