azure.azcollection.azure_rm_sqlelasticpool 模块 – 管理 SQL 弹性池实例

注意

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

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

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

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

azure.azcollection 1.14.0 中的新增功能

概要

  • 创建、更新和删除 SQL 弹性池实例。

要求

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

  • 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"

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，否则将使用默认的 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 环境变量来设置。

选项

  • “忽略”

  • “验证”

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

license_type

字符串

要应用于此弹性池的许可证类型。

选项

  • "LicenseIncluded" ← (默认)

  • “BasePrice”

location

字符串

资源位置。如果未设置，则将使用资源组中的位置作为默认值。

log_mode

字符串

父参数。

log_path

字符串

父参数。

maintenance_configuration_id

字符串

分配给弹性池的维护配置 ID。

max_size_bytes

字符串

弹性池的最大大小，以字节表示。

如果不是 *create_mode=default*，则忽略此值。

要查看可能的值，请查询功能 API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities)。由 operationId:’Capabilities_ListByLocation’ 引用。

name

字符串 / 必需

要操作（更新或创建）的弹性池的名称。

password

字符串

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

per_elasticpool_settings

字典

弹性池的每个数据库设置。

max_capacity

浮点数

保证所有数据库的最大容量。

min_capacity

浮点数

保证所有数据库的最小容量。

profile

字符串

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

resource_group

字符串 / 必需

包含资源的资源组的名称。

您可以从 Azure 资源管理器 API 或门户获取此值。

secret

字符串

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

server_name

字符串 / 必需

服务器的名称。

sku

字典

弹性池的 SKU。Elastic PoolEditions 枚举包含所有有效的 SKU。

capacity

整数

特定 SKU 的容量。

family

字符串

如果服务对于同一 SKU 具有不同的硬件代数，则可以在此处使用

name

字符串 / 必需

弹性池 SKU 的名称，通常是一个字母 + 数字代码，例如 P3

size

字符串

特定 SKU 的大小

tier

字符串

特定 SKU 的层或版本，例如 Basic、Premium

state

字符串

断言 SQL 弹性池的状态。使用 present 创建或更新 SQL 弹性池，并使用 absent 删除它。

选项

  • “absent”

  • "present" ← (默认)

subscription_id

字符串

您的 Azure 订阅 ID。

tags

字典

要作为元数据分配给对象的字符串：字符串对的字典。

对象上的元数据标记将使用提供的任何值进行更新。

要删除标记，请将 append_tags 选项设置为 false。

目前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。

Azure 前门不支持使用

Azure 自动化和 Azure CDN 仅支持资源上的 15 个标记。

tenant

字符串

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

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

在 *x509_certificate_path* 中指定的私钥的指纹。

在通过服务主体进行身份验证时使用。

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

x509_certificate_path

路径

在 azure.azcollection 1.14.0 中添加

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

证书必须附加到私钥。

在通过服务主体进行身份验证时使用。

zone_redundant

布尔值

此弹性池是否是区域冗余的？这意味着此弹性池的副本将分布在多个可用性区域中。

选项

  • false ← (默认)

  • true

备注

注意

  • 要使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或剧本之前使用 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) SQL Elastic Pool
  azure_rm_elastic_pool:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: testEP
    zone_redundant: false
    sku:
      name: GP_Gen5
      family: Gen5
      capacity: 3
    tags:
      key1: value1

- name: Delete SQL Elastic Pool
  azure_rm_elastic_pool:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: testEP
    state: absent

返回值

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

键

描述

elastic_pool

复杂

包含 SQL 弹性池事实的字典列表。

已返回: 始终

id

字符串

资源 ID。

已返回: 始终

示例: "/subscriptions/xxx-xxx/resourceGroups/testrg/providers/Microsoft.Sql/servers/sqlsrvfredsqldb/elasticPools/fedelastic01"

license_type

字符串

要应用于此弹性池的许可证类型。

已返回: 始终

示例: "LicenseIncluded"

location

字符串

资源位置。

已返回: 始终

示例: "eastus"

maintenance_configuration_id

字符串

分配给弹性池的维护配置 ID。

已返回: 始终

示例: "/subscriptions/xxx-xxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"

max_size_bytes

字符串

数据库弹性池的存储限制，以字节为单位。

已返回: 始终

示例: "34359738368"

name

字符串

弹性池名称。

已返回: 始终

示例: "testEP"

per_database_settings

复杂

弹性池的每个数据库设置。

已返回: 始终

max_capacity

浮点数

任何一个数据库可以消耗的最大容量。

已返回: 始终

示例: 2.0

min_capacity

浮点数

保证所有数据库的最小容量

已返回: 始终

示例: 0.0

sku

复杂

SKU 的名称和层。

已返回: 始终

capacity

整数

SKU 容量。

已返回: 始终

示例: 2

family

字符串

如果服务对于同一 SKU 具有不同的硬件代数，则可以在此处捕获。

已返回: 始终

示例: "Gen5"

name

字符串

SKU 的名称。

已返回: 始终

示例: "GP_Gen5"

size

字符串

特定 SKU 的大小。

已返回: 始终

tier

字符串

SKU 层。

已返回: 始终

示例: "GeneralPurpose"

tags

字典

资源标记。

已返回: 始终

示例: {"taga": "aaa", "tagb": "bbb"}

zone_redundant

布尔值

此数据库是否为区域冗余，这意味着此数据库的副本将分布在多个可用性区域中。

已返回: 始终

示例: true

作者

  • xuzhang3 (@xuzhang3)

  • Fred Sun (@Fred-sun)