azure.azcollection.azure_rm_sqlelasticpool_info 模块 – 获取 Azure 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_info。

azure.azcollection 1.14.0 中的新增功能

概要

  • 获取 Azure SQL 弹性池的事实。

要求

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

  • python >= 2.7

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

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

  • 完整的安装说明可在 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（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。

Ansible 2.6 中添加了 msi。

选项

  • "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 资源管理器 API 或门户获取此值。

secret

字符串

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

server_name

字符串 / 必需

服务器的名称。

subscription_id

字符串

您的 Azure 订阅 ID。

tags

列表 / 元素=字符串

通过提供标签列表来限制结果。将标签格式化为“键”或“键：值”。

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 证书的路径。

证书必须附加到私钥。

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

注释

注意

  • 对于使用 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: Get instance of SQL Elastic Pool
  azure_rm_sqlelasticpool_info:
    resource_group: testrg
    server_name: testserver
    name: testEP

- name: List instances of SQL Elastic Pool
  azure_rm_sqlelasticpool_info:
    resource_group: testrg
    server_name: testserver

返回值

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

键

描述

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)