azure.azcollection.azure_rm_mysqlserver 模块 – 管理 MySQL 服务器实例

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 创建、更新和删除 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 授权时使用。

admin_password

字符串

管理员登录的密码。

admin_username

字符串

服务器的管理员登录名。

只能在创建服务器时指定（并且是创建所必需的）。

api_profile

字符串

在 azure.azcollection 0.0.1 中添加

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

默认值： "latest"

append_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（如果存在多个订阅 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"

create_mode

字符串

SQL Server 的创建模式。

默认值: "Default"

disable_instance_discovery

布尔值

在 azure.azcollection 2.3.0 中添加

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

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

选择

  • false ← (默认)

  • true

enforce_ssl

布尔值

启用 SSL 强制。

选择

  • false ← (默认)

  • true

location

字符串

资源位置。如果未设置，则默认使用资源组的位置。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必需

服务器的名称。

password

字符串

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

profile

字符串

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

resource_group

字符串 / 必需

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

restarted

布尔值

当使用 state=present 时设置为 true 以重新启动正在运行的 MySQL 服务器。

选择

  • false ← (默认)

  • true

secret

字符串

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

sku

字典

服务器的 SKU（定价层）。

capacity

字符串

向上/向外扩展容量，表示服务器的计算单元。

name

字符串

SKU 的名称，通常是层 + 系列 + 核心，例如 B_Gen4_1, GP_Gen5_8。

size

整数

大小代码，由资源根据需要进行解释。

tier

字符串

特定 SKU 的层，例如 Basic。

选择

  • "basic"

  • "standard"

state

字符串

声明 MySQL 服务器的状态。使用 present 创建或更新服务器，使用 absent 删除服务器。

选择

  • "absent"

  • "present" ← (默认)

storage_profile

字典

服务器的存储配置文件属性。

backup_retention_days

整数

服务器的备份保留天数

geo_redundant_backup

字符串

是否为服务器备份启用异地冗余。

选择

  • "Disabled"

  • "Enabled"

storage_autogrow

字符串

启用存储自动增长。

选择

  • "Disabled"

  • "Enabled"

storage_mb

整数

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

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"

x509_certificate_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: Create (or update) MySQL Server
  azure_rm_mysqlserver:
    resource_group: myResourceGroup
    name: testserver
    sku:
      name: B_Gen5_1
      tier: Basic
    location: eastus
    storage_profile:
      storage_mb: 51200
      backup_retention_days: 7
      geo_redundant_backup: Disabled
      storage_autogrow: Disabled
    enforce_ssl: true
    version: 5.7
    admin_username: cloudsa
    admin_password: "{{ password }}"

返回值

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

键

描述

fully_qualified_domain_name

字符串

服务器的完全限定域名。

返回: 始终

示例: "mysqlsrv1b6dd89593.mysql.database.azure.com"

id

字符串

资源 ID。

返回: 始终

示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/mysqlsrv1b6dd89593"

state

字符串

用户可见的服务器状态。可能的值包括 Ready、 Dropping、 Disabled。

返回: 始终

示例: "Ready"

version

字符串

服务器版本。可能的值包括 5.6、 5.7、 8.0。

返回: 始终

示例: "5.7"

作者

  • Zim Kalinowski (@zikalino)