azure.azcollection.azure_rm_mysqlflexibleserver 模块 – 管理 MySQL 灵活服务器实例

注意

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

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

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

要在 playbook 中使用它，请指定： azure.azcollection.azure_rm_mysqlflexibleserver。

azure.azcollection 2.7.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 授权时使用。
administrator_login 字符串	服务器管理员的登录名。 只能在创建服务器时指定（并且是创建所必需的）。
administrator_login_password 字符串	管理员登录的密码。
api_profile 字符串 在 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时使用的 API 配置文件。 默认值 latest 适用于公共云； 将来的值将允许与 Azure Stack 一起使用。 默认值: "latest"
append_tags 布尔值	用于控制 tags 字段是规范的还是仅附加到现有 tags。 当为规范时，tags 参数中未找到的任何 tags 将从对象的元数据中删除。 选项 false true ← (默认值)
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"
availability_zone 字符串	服务器的可用性区域信息。
backup 字典	服务器的备份相关属性。
backup_retention_days 整数	服务器的备份保留天数。
geo_redundant_backup 字符串	是否启用异地冗余备份。 选项 "启用" "禁用"
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
high_availability 字典	服务器的高可用性相关属性。
mode 字符串	服务器的高可用性模式。 选项 "禁用" "ZoneRedundant" "SameZone"
standby_availability_zone 字符串	备用服务器的可用性区域。
location 字符串	资源位置。如果未设置，将使用资源组中的位置作为默认值。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串 / 必需	服务器的名称。
network 字典	服务器的网络相关属性。
delegated_subnet_resource_id 字符串	用于为服务器设置虚拟网络的委派子网资源 ID。
private_dns_zone_resource_id 字符串	私有 DNS 区域资源 ID。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	包含资源的资源组的名称。您可以从 Azure 资源管理器 API 或门户获取此值。
restore_point_in_time 字符串	还原点创建时间（ISO8601 格式），指定要从哪个时间还原。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
sku 字典	服务器的 SKU（定价层）。
name 字符串 / 必需	SKU 的名称，例如 Standard_D32s_v3。
tier 字符串 / 必需	特定 SKU 的层级。 选项 "Burstable" "GeneralPurpose" "MemoryOptimized"
source_server_resource_id 字符串	源 MySQL 服务器 ID。
state 字符串	断言 MySQL 弹性服务器的状态。使用 present 创建或更新服务器，使用 absent 删除服务器。 选项 "absent" "present" ← (默认)
status 字符串	设置服务器状态。 选项 "restart" "start" "stop" "failover"
storage 字典	服务器的存储配置文件属性。
auto_grow 字符串	是否启用存储自动增长。 选项 "禁用" "启用"
iops 整数	服务器的存储 IOPS。
storage_size_gb 整数	服务器允许的最大存储大小。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要分配为对象元数据的字符串：字符串对的字典。 对象的元数据标签将使用任何提供的值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure Front Door 不支持使用 Azure Automation 和 Azure CDN 仅支持资源上的 15 个标签。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。
version 字符串	服务器版本。 选项 "5.7" "8.0.21"
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 中。这是一个包含 [default] 部分和以下键的 ini 文件：subscription_id、client_id、secret 和 tenant，或者 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Create mysql flexible server
  azure_rm_mysqlflexibleserver:
    resource_group: "{{ resource_group }}"
    name: postflexible{{ rpfx }}
    sku:
      name: Standard_D2ds_v4
      tier: GeneralPurpose
    administrator_login: azureuser
    administrator_login_password: Fred@0329
    location: northeurope
    version: 5.7
    storage:
      storage_size_gb: 128
      iops: 500
      auto_grow: Enabled
    high_availability:
      mode: ZoneRedundant
      standby_availability_zone: 3
    backup:
      backup_retention_days: 7
      geo_redundant_backup: Disabled
    availability_zone: 1

返回值

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

键	描述
servers 复杂	弹性服务器的事实。 返回: 总是
administrator_login_password 字符串	服务器管理员的登录名。 返回: 总是 示例: "serveradmin"
availability_zone 字符串	服务器的可用性区域信息。 返回: 总是 示例: "1"
backup 复杂	服务器的备份相关属性。 返回: 成功
backup_retention_days 整数	服务器的备份保留天数。 返回: 总是 示例: 7
geo_redundant_backup 字符串	是否启用异地冗余备份。 返回: 总是 示例: "Disabled"
fully_qualified_domain_name 字符串	服务器的完全限定域名。 返回: 总是 示例: "myabdud1223.mys.database.azure.com"
high_availability 复杂	服务器的高可用性相关属性。 返回: 总是
mode 字符串	服务器的高可用性模式。 返回: 总是 示例: "Disabled"
standby_availability_zone 字符串	备用服务器的可用性区域。 返回: 总是 示例: "Availability zone of the standby server."
id 字符串	资源 ID。 返回: 总是 示例: "/subscriptions/xxxx-xxxx/resourceGroups/testRG/providers/Microsoft.DBforMySQL/flexibleServers/server01"
location 字符串	资源所在的地理位置。 返回: 总是 示例: "eastus"
name 字符串	资源名称。 返回: 总是 示例: "server01"
network 复杂	服务器的网络相关属性。 返回: 总是
delegated_subnet_resource_id 字符串	用于为服务器设置虚拟网络的委派子网资源 ID。 返回: 总是
private_dns_zone_resource_id 字符串	私有 DNS 区域资源 ID。 返回: 总是
resource_group 字符串	资源组名称。 返回: 总是 示例: "testRG"
restore_point_in_time 字符串	还原点创建时间（ISO8601 格式），指定要从哪个时间还原。 返回: 总是
sku 复杂	服务器的 SKU。 返回: 总是
name 字符串	SKU 的名称。 返回: 总是 示例: "Standard_D32s_v3"
tier 字符串	特定 SKU 的层级。 返回: 总是 示例: "GeneralPurpose"
source_server_resource_id 字符串	源 MySQL 服务器 ID。 返回: 总是
state 字符串	用户可见的服务器状态。 返回: 总是 示例: "Ready"
status 字符串	设置服务器状态。 返回: 成功 只能返回 "restart" "start" "stop" "failover"
storage 复杂	服务器的存储相关属性。 返回: 总是
auto_grow 字符串	是否启用存储自动增长。 返回: 总是 示例: "Disabled"
iops 整数	服务器的存储 IOPS。 返回: 总是 示例: 684
storage_size_gb 整数	服务器允许的最大存储大小。 返回: 总是 示例: 128000
tags 字典	分配给资源的标签。字符串：字符串对的字典。 返回: 总是 示例: {"tag1": "abc"}
type 字符串	资源的类型。 返回: 总是 示例: "Microsoft.DBforMySQL/flexibleServers"
version 字符串	服务器版本。 返回: 总是 示例: "5.7"

作者

• xuzhang3 (@xuzhang3)

• Fred-sun (@Fred-sun)

集合链接

• 问题跟踪器
• 主页
• 存储库 (源代码)