azure.azcollection.azure_rm_sqldatabase 模块 – 管理 SQL 数据库实例

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要 

创建、更新和删除 SQL 数据库实例。

要求 

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

python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
必须通过 pip 在执行来自 azure.azcollection 模块的主机上安装 collection 的 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 布尔值	用于控制标签字段是规范的还是仅附加到现有标签。当为规范时，标签参数中未找到的任何标签将从对象的元数据中删除。选项 `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` 环境变量进行设置。选项 `"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"`
collation 字符串	数据库的排序规则。如果不是 create_mode=default，则忽略此值。
create_mode 字符串	指定数据库创建的模式。 `default`，常规数据库创建。 `copy`，创建一个作为现有数据库副本的数据库。 `online_secondary`/`non_readable_secondary`，创建一个数据库作为现有数据库的（可读或不可读）辅助副本。 `point_in_time_restore`，通过还原现有数据库的时间点备份来创建数据库。 `recovery`，通过还原异地复制的备份来创建数据库。 `restore`，通过还原已删除数据库的备份来创建数据库。 `restore_long_term_retention_backup`，通过从长期保留库还原来创建数据库。 `copy`, `non_readable_secondary`, `online_secondary` 和 `restore_long_term_retention_backup` 不支持 `data_warehouse` 版本。选项 `"copy"` `"default"` `"non_readable_secondary"` `"online_secondary"` `"point_in_time_restore"` `"recovery"` `"restore"` `"restore_long_term_retention_backup"`
disable_instance_discovery 布尔值在 azure.azcollection 2.3.0 中添加	确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点的情况，例如在私有云或 Azure Stack 中。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此项设置为 True，将禁用对授权的验证。因此，必须确保配置的授权主机是有效且可信的。通过凭据文件配置文件或 `AZURE_DISABLE_INSTANCE_DISCOVERY` 环境变量设置。选项 `false` ← (默认) `true`
edition 字符串	（已弃用）数据库的版本。DatabaseEditions 枚举包含所有有效的版本。此选项将在 2.11 中弃用，请改用 sku。设置此字段时，无法设置 `sku`。选项 `"web"` `"business"` `"basic"` `"standard"` `"premium"` `"free"` `"stretch"` `"data_warehouse"` `"system"` `"system2"`
elastic_pool_name 字符串	数据库所在的弹性池的名称。不支持 edition=data_warehouse。
force_update 布尔值	如果给定的参数与现有资源状态不同，则将更新 SQL 数据库。要在任何情况下强制更新 SQL 数据库，请将此参数设置为 True。选项 `false` `true`
location 字符串	资源位置。如果未设置，则将使用资源组中的位置作为默认值。
log_mode 字符串	父参数。
log_path 字符串	父参数。
max_size_bytes 字符串	数据库的最大大小（以字节表示）。如果不是 create_mode=default，则将忽略此值。要查看可能的值，请查询 capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities)。由 operationId:’Capabilities_ListByLocation’ 引用。
name string / required	要操作（更新或创建）的数据库的名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
read_scale 布尔值	如果数据库是异地辅助数据库，则指示是否允许只读连接到此数据库。不支持 edition=data_warehouse。选项 `false` ← (默认) `true`
recovery_services_recovery_point_resource_id 字符串	如果 create_mode=restore_long_term_retention_backup，则此值为必填项。指定要从中还原的恢复点的资源 ID。
resource_group string / required	包含资源的资源组的名称。您可以从 Azure 资源管理器 API 或门户获取此值。
restore_point_in_time 字符串	如果 create_mode=point_in_time_restore，则此值为必填项。如果 create_mode=restore，则此值为可选的。指定将还原源数据库（ISO8601 格式）的时间点以创建新数据库。必须大于或等于源数据库的 earliestRestoreDate 值。
sample_name 字符串	指示创建此数据库时要应用的示例架构的名称。如果不是 create_mode=default，则将忽略此值。不支持 edition=data_warehouse。选项 `"adventure_works_lt"`
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
server_name string / required	服务器的名称。
sku dictionary	数据库的 SKU。DatabaseEditions 枚举包含所有有效的 SKU。如果 create_mode=non_readable_secondary 或 create_mode=online_secondary，则将忽略此值。要查看可能的值，请查询 capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities)，由 operationId:’Capabilities_ListByLocation’ 引用。设置此字段时，无法设置 `edition`。
capacity integer	特定 SKU 的容量。
family 字符串	如果该服务对于同一 SKU 具有不同的硬件代系，则可以在此处使用
name string / required	数据库 SKU 的名称，通常是一个字母 + 数字代码，例如 P3
size 字符串	特定 SKU 的大小
tier 字符串	特定 SKU 的层或版本，例如 Basic、Premium
source_database_deletion_date 字符串	如果 create_mode=restore 且 source_database_id 是已删除数据库存在时（而不是其当前可还原的已删除数据库 ID）的原始资源 ID，则此值为必填项。指定数据库被删除的时间。
source_database_id 字符串	除非 create_mode=default 或 create_mode=restore_long_term_retention_backup，否则此项为必填项。指定源数据库的资源 ID。
state 字符串	断言 SQL 数据库的状态。使用 `present` 创建或更新 SQL 数据库，使用 `absent` 删除它。选项 `"absent"` `"present"` ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags dictionary	要分配为对象元数据的字符串:字符串对的字典。对象的元数据标记将使用任何提供的值进行更新。要删除标签，请将 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，则为必填项。
x509_certificate_path path 在 azure.azcollection 1.14.0 中添加	用于以 PEM 格式创建服务主体的 X509 证书的路径。必须将证书附加到私钥。当使用服务主体进行身份验证时使用。
zone_redundant 布尔值	此数据库是否为区域冗余？这意味着此数据库的副本将分布在多个可用性区域中。选项 `false` ← (默认) `true`

说明 

注意

对于 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) SQL Database
  azure_rm_sqldatabase:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: testdb
    location: eastus

- name: Restore SQL Database
  azure_rm_sqldatabase:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: restoreddb
    location: eastus
    create_mode: restore
    source_database_deletion_date: '2024-07-26T17:50:01Z'

- name: Create SQL Database in Copy Mode
  azure_rm_sqldatabase:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: copydb
    location: eastus
    create_mode: copy
    source_database_id: "/subscriptions/xxxx-xxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/testsvr/databases/testdb"

- name: Create (or update) SQL Database with SKU
  azure_rm_sqldatabase:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: testdb
    location: eastus
    sku:
      name: S0

返回值 

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

键	描述
database_id 字符串	数据库的 ID。返回：始终示例： `"database_id"`
id 字符串	资源 ID。返回：始终示例： `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb"`
status 字符串	数据库的状态。返回：始终示例： `"Online"`

作者

Zim Kalinowski (@zikalino)