azure.azcollection.azure_rm_cosmosdbaccount 模块 – 管理 Azure 数据库帐户实例
注意
此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求了解详细信息。
要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_cosmosdbaccount。
azure.azcollection 0.1.2 中的新增功能
概要
创建、更新和删除 Azure 数据库帐户的实例。
要求
执行此模块的主机需要满足以下要求。
python >= 2.7
执行此模块的主机必须通过 galaxy 安装了 azure.azcollection 集合
必须通过 pip 在执行 azure.azcollection 模块的主机上安装集合的 requirements.txt 中列出的所有 python 包
完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到
参数
参数 |
注释 |
|---|---|
Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且具有自己的 ADFS 授权时使用。 |
|
选择与 Azure 服务通信时使用的 API 配置文件。默认值 默认值： |
|
用于控制 tags 字段是规范的还是仅附加到现有标签。 当为规范时，在 tags 参数中找不到的任何标签将从对象的元数据中删除。 选择
|
|
控制用于身份验证的凭据的来源。 也可以通过 设置为 设置为 设置为 设置为 设置为
选择
|
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 选择
|
|
Azure 客户端 ID。当使用服务主体或托管身份 (msi) 进行身份验证时使用。 也可以通过 |
|
对于美国公共云以外的云环境，需要提供环境名称（如 Azure Python SDK 定义的，例如 默认值： |
|
Cosmos DB 帐户的一致性策略。 |
|
Cosmos DB 帐户的默认一致性级别和配置设置。 当 state=present 时为必需。 选择
|
|
当与“有界过时”一致性级别一起使用时，此值表示容许的过时时间量（以秒为单位）。 此值的接受范围为 5 - 86400。当 default_consistency_policy=bounded_staleness 时为必需。 |
|
当与“有界过时”一致性级别一起使用时，此值表示容许的过时请求数。 此值的接受范围为 1 - 2,147,483,647。当 default_consistency_policy=bounded_staleness 时为必需。 |
|
数据库帐户套餐类型，例如 Standard 当 state=present 时为必需。 |
|
在 CMK 相关功能中访问密钥保管库的主标识。例如，‘FirstPartyIdentity’、‘SystemAssignedIdentity’ 等。用户分配的标识以 ‘UserAssignedIdentity=<用户分配的标识的资源 ID>’ 的格式指定。 |
|
确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据终结点的情况，例如在私有云或 Azure Stack 中。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此设置为 **True**，将禁用授权的验证。因此，至关重要的是确保配置的授权主机有效且可信。 通过凭据文件配置文件或 选择
|
|
在极少数情况下，如果某个区域因中断而不可用，则启用写入区域的自动故障转移。 自动故障转移将导致该帐户出现新的写入区域，并且该区域是根据为该帐户配置的故障转移优先级选择的。 选择
|
|
启用 Cassandra。 选择
|
|
如果启用，则该帐户为免费层。 选择
|
|
启用 Gremlin。 选择
|
|
允许帐户在多个位置写入 选择
|
|
启用 Table。 选择
|
|
一个数组，其中包含为 Cosmos DB 帐户启用的异地复制位置。 当 state=present 时为必需。 |
|
区域的故障转移优先级。故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = (区域总数 - 1)。 对于数据库帐户所在的每个区域，故障转移优先级值必须是唯一的。 |
|
区域的名称。 |
|
对象的标识 |
|
托管标识的类型 选择
|
|
用户分配的托管标识及其选项 默认值： |
|
标识列表是要附加到当前标识 (true)，还是要替换当前标识 (false) 选择
|
|
与对象关联的用户分配标识 ID 的列表 默认值： |
|
（已弃用）Cosmos DB 防火墙支持。此值指定 IP 地址或 IP 地址范围的集合。 以 CIDR 形式包含在给定数据库帐户的允许客户端 IP 列表中。 IP 地址/范围必须用逗号分隔，且不得包含任何空格。 此值已弃用，将在后续版本中删除。请改用 ip_rules。 |
|
以 CIDR 形式包含在允许的客户端 IP 列表中的 IP 地址或 IP 地址范围。 |
|
指示是否启用/禁用虚拟网络 ACL 规则的标志。 选择
|
|
指示数据库帐户的类型。这只能在创建数据库帐户时设置。 选择
|
|
资源所属的资源组的位置。 当 state=present 时为必需。 |
|
父参数。 |
|
父参数。 |
|
MongoDB 帐户的服务器版本，例如 c(3.2) 或 c(4.0)。 仅当 c(kind) = i(mongo_db) 时使用。 |
|
Cosmos DB 数据库帐户名称。 |
|
Active Directory 用户密码。在通过 Active Directory 用户而非服务主体进行身份验证时使用。 |
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
启用或禁用对服务器的公共网络访问。 选择
|
|
Azure 资源组的名称。 |
|
Azure 客户端密钥。在通过服务主体进行身份验证时使用。 |
|
断言数据库帐户的状态。 使用 选择
|
|
你的 Azure 订阅 ID。 |
|
要作为元数据分配给对象的字符串：字符串对的字典。 对象上的元数据标记将使用任何提供的值进行更新。 要删除标记，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。 Azure Front Door 不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标记。 |
|
Azure 租户 ID。在通过服务主体进行身份验证时使用。 |
|
在 x509_certificate_path 中指定的私钥的指纹。 在通过服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。 |
|
为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。 |
|
创建没有现有虚拟网络服务终结点的 Cosmos DB 帐户。 选择
|
|
它可以是包含子网资源 ID 的字符串。 它可以是包含 'resource_group'、'virtual_network_name' 和 'subnet_name' 的字典 |
|
用于创建 PEM 格式的服务主体的 X509 证书的路径。 该证书必须附加到私钥。 在通过服务主体进行身份验证时使用。 |
注释
注意
对于 Azure 身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在使用
az login运行任务或 playbook 之前登录。也可以使用服务主体或 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 Cosmos DB Account - min
azure_rm_cosmosdbaccount:
resource_group: myResourceGroup
name: myDatabaseAccount
location: westus
geo_rep_locations:
- name: southcentralus
failover_priority: 0
database_account_offer_type: Standard
- name: Create Cosmos DB Account - max
azure_rm_cosmosdbaccount:
resource_group: myResourceGroup
name: myDatabaseAccount
location: westus
kind: mongo_db
geo_rep_locations:
- name: southcentralus
failover_priority: 0
database_account_offer_type: Standard
ip_rules:
- 10.10.10.10
enable_multiple_write_locations: true
virtual_network_rules:
- subnet: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVi
rtualNetwork/subnets/mySubnet"
consistency_policy:
default_consistency_level: bounded_staleness
max_staleness_prefix: 10
max_interval_in_seconds: 1000
返回值
常见的返回值在此处记录 这里，以下是此模块独有的字段
键 |
描述 |
|---|---|
数据库帐户的唯一资源标识符。 返回: 总是 示例: |