azure.azcollection.azure_rm_cosmosdbaccount_info 模块 – 获取 Azure Cosmos DB 账户信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在 Playbook 中使用它，请指定：azure.azcollection.azure_rm_cosmosdbaccount_info。

azure.azcollection 0.1.2 中的新功能

概要

  • 获取 Azure Cosmos DB 账户的信息。

要求

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

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

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"

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

字符串

Cosmos DB 数据库帐户名称。

password

字符串

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

profile

字符串

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

resource_group

字符串

Azure 资源组的名称。

retrieve_connection_strings

布尔值

检索连接字符串。

选择

  • false

  • true

retrieve_keys

字符串

检索密钥和连接字符串。

选择

  • "all"

  • "readonly"

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tags

list / elements=string

通过提供标签列表来限制结果。将标签格式化为 ‘key’ 或 ‘key:value’。

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

该证书必须附加到私钥。

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

备注

注意

  • 要使用 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 中。这是一个包含 [default] 部分和以下键的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Get instance of Database Account
  azure_rm_cosmosdbaccount_info:
    resource_group: myResourceGroup
    name: testaccount

- name: List instances of Database Account
  azure_rm_cosmosdbaccount_info:
    resource_group: myResourceGroup
    tags:
      - key
      - key:value

返回值

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

Key

描述

accounts

complex

包含数据库帐户事实的字典列表。

返回: 始终

connection_strings

list / elements=string

连接字符串列表。

返回: 当请求时

connection_string

字符串

连接字符串的描述。

返回: 始终

示例: "Primary SQL Connection String"

description

字符串

连接字符串。

返回: 始终

示例: "AccountEndpoint=https://testaccount.documents.azure.com:443/;AccountKey=xxxxx"

consistency_policy

complex

一致性策略。

返回: 始终

default_consistency_level

字符串

默认一致性级别。

返回: 始终

示例: "session"

max_interval_in_seconds

integer

最大间隔（以秒为单位）。

返回: 始终

示例: 5

max_staleness_prefix

integer

最大陈旧前缀。

返回: 始终

示例: 100

database_account_offer_type

字符串

优惠类型。

返回: 始终

示例: "Standard"

document_endpoint

字符串

文档端点。

返回: 始终

示例: "https://testaccount.documents.azure.com:443/"

enable_automatic_failover

布尔值

启用自动故障转移。

返回: 始终

示例: true

enable_cassandra

布尔值

启用 Cassandra。

返回: 始终

示例: true

enable_free_tier

布尔值

在 azure.azcollection 1.10.0 中添加

如果启用，则该帐户为免费层。

返回: 始终

示例: true

enable_gremlin

布尔值

启用 Gremlin。

返回: 始终

示例: true

enable_multiple_write_locations

布尔值

启用多个写入位置。

返回: 始终

示例: true

enable_table

布尔值

启用 Table。

返回: 始终

示例: true

failover_policies

complex

用于故障转移优先级更改的新故障转移策略列表。

返回: 始终

failover_priority

integer

故障转移优先级。

返回: 始终

示例: 0

id

字符串

读取位置 ID。

返回: 始终

示例: "testaccount-eastus"

name

字符串

位置名称。

返回: 始终

示例: "eastus"

id

字符串

数据库帐户的唯一资源标识符。

返回: 始终

示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccount s/testaccount"

ip_range_filter

字符串

(已弃用) 启用的 IP 范围过滤器。

此值已被弃用，将在以后的版本中删除。请改用 c(ip_rules)。

返回: 始终

示例: "10.10.10.10"

ip_rules

list / elements=string

在 azure.azcollection 1.10.0 中添加

以 CIDR 形式包含的 IP 地址或 IP 地址范围，作为允许的客户端 IP 列表。

返回: 始终

示例: ["10.10.10.10", "20.20.20.20/28"]

is_virtual_network_filter_enabled

布尔值

启用虚拟网络过滤器。

返回: 始终

示例: true

kind

字符串

指示数据库帐户的类型。

返回: 始终

示例: "global_document_db"

location

字符串

资源所属资源组的位置。

返回: 始终

示例: "westus"

mongo_version

字符串

在 azure.azcollection 1.10.0 中添加

MongoDB 帐户的服务器版本。

仅用于 c(kind) = i(mongo_db)；否则，值为 null/none。

返回: 始终

示例: "4.0"

name

字符串

数据库帐户的名称。

返回: 始终

示例: "testaccount"

primary_master_key

字符串

主密钥。

返回: 当请求时

示例: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

primary_readonly_master_key

字符串

主密钥。

返回: 当请求时

示例: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

provisioning_state

字符串

Cosmos DB 的预配状态。

返回: 始终

示例: "Succeeded"

public_network_access

字符串

在 azure.azcollection 1.10.0 中添加

是否允许公共网络访问服务器。

返回: 始终

示例: "Enabled"

read_locations

complex

读取位置。

返回: 始终

document_endpoint

字符串

文档端点。

返回: 始终

示例: "https://testaccount-eastus.documents.azure.com:443/"

failover_priority

integer

故障转移优先级。

返回: 始终

示例: 0

id

字符串

读取位置 ID。

返回: 始终

示例: "testaccount-eastus"

name

字符串

位置名称。

返回: 始终

示例: "eastus"

provisioning_state

字符串

预配状态。

返回: 始终

示例: "Succeeded"

resource_group

字符串

Azure 资源组的名称。

返回: 始终

示例: "myResourceGroup"

secondary_master_key

字符串

主密钥。

返回: 当请求时

示例: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

secondary_readonly_master_key

字符串

主密钥。

返回: 当请求时

示例: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

tags

dictionary

分配给资源的标签。 “string”:”string” 对的字典。

返回: 始终

示例: {"tag1": "abc"}

virtual_network_rules

list / elements=string

为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。

返回: 成功

ignore_missing_v_net_service_endpoint

布尔值

创建没有现有虚拟网络服务终结点的 Cosmos DB 帐户。

返回: 成功

subnet

字符串

子网的资源 ID。

返回: 成功

示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNet works/testvnet/subnets/testsubnet1"

write_locations

complex

写入位置。

返回: 始终

document_endpoint

字符串

文档端点。

返回: 始终

示例: "https://testaccount-eastus.documents.azure.com:443/"

failover_priority

integer

故障转移优先级。

返回: 始终

示例: 0

id

字符串

读取位置 ID。

返回: 始终

示例: "testaccount-eastus"

name

字符串

位置名称。

返回: 始终

示例: "eastus"

provisioning_state

字符串

预配状态。

返回: 始终

示例: "Succeeded"

作者

  • Zim Kalinowski (@zikalino)