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 集合
集合的 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"`
append_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` 环境变量设置。选项 `"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`，通过从长期保留保管库还原来创建数据库。对于`data_warehouse`版本，不支持`copy`、`non_readable_secondary`、`online_secondary`和`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`
版本字符串	(已弃用)数据库的版本。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`
位置字符串	资源位置。如果未设置，则将使用资源组中的位置作为默认值。
日志模式字符串	父参数。
日志路径字符串	父参数。
max_size_bytes 字符串	以字节表示的数据库最大大小。如果create_mode=default，则忽略此值。要查看可能的取值，请查询功能 API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities)。由 operationId:’Capabilities_ListByLocation’ 引用。
名称字符串 / 必需	要对其进行操作（更新或创建）的数据库的名称。
密码字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
配置文件字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
read_scale 布尔值	如果数据库是地理辅助数据库，则指示是否允许对此数据库进行只读连接。 edition=data_warehouse 不支持。选项 `false` ← (默认) `true`
recovery_services_recovery_point_resource_id 字符串	如果create_mode=restore_long_term_retention_backup，则需要此值。指定要从中还原恢复点的资源 ID。
资源组字符串 / 必需	包含资源的资源组的名称。您可以从 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"`
密钥字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
服务器名称字符串 / 必需	服务器的名称。
sku 字典	数据库的 sku。DatabaseEditions 枚举包含所有有效的 sku。如果create_mode=non_readable_secondary 或create_mode=online_secondary，则忽略此值。要查看可能的取值，请查询功能 API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities)，由 operationId:’Capabilities_ListByLocation’ 引用。设置此字段时，无法设置`edition`。
容量整数	特定 SKU 的容量。
系列字符串	如果服务针对同一 SKU 具有不同代的硬件，则可以使用此参数。
名称字符串 / 必需	数据库 SKU 的名称，通常是字母 + 数字代码，例如 P3
大小字符串	特定 SKU 的大小
层级字符串	特定 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。
状态字符串	声明 SQL 数据库的状态。使用`present`创建或更新 SQL 数据库，使用`absent`删除它。选项 `"absent"` `"present"` ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
标签字典	要作为元数据分配给对象的字符串：字符串对的字典。对象的元数据标签将使用任何提供的 value 进行更新。要删除标签，请将 append_tags 选项设置为 false。目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。
租户字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
指纹字符串 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 中的配置文件，或者在运行任务或 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 (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"`
状态字符串	数据库的状态。返回：始终示例：`"Online"`

作者

Zim Kalinowski (@zikalino)