azure.azcollection.azure_rm_keyvault_info 模块 – 获取 Azure 密钥库信息

注意

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

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

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

要在剧本中使用它，请指定：azure.azcollection.azure_rm_keyvault_info。

azure.azcollection 0.1.2 中的新增功能

概要

• 获取 Azure 密钥库的事实。

要求

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

• 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 字符串	密钥库的名称。
password 字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串	密钥保管库所属的资源组的名称。
secret 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 列表 / 元素=字符串	通过提供标签列表来限制结果。标签格式为“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 中。这是一个 ini 文件，其中包含一个 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Get Key Vault by name
  azure_rm_keyvault_info:
    resource_group: myResourceGroup
    name: myVault

- name: List Key Vaults in specific resource group
  azure_rm_keyvault_info:
    resource_group: myResourceGroup

- name: List Key Vaults in current subscription
  azure_rm_keyvault_info:

返回值

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

键	描述
keyvaults 列表 / 元素=字符串	Azure 密钥保管库的列表。 返回：始终
access_policies 复杂	策略列表。 返回：始终
object_id 字符串	用户、服务主体或 AAD 中保管库的安全组的对象 ID。 返回：始终 示例： "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
permissions 复杂	标识对密钥、机密和证书具有的权限。 返回：始终
certificates 列表 / 元素=字符串	对机密的权限。 返回：始终 示例： ["get", "import"]
keys 列表 / 元素=字符串	对密钥的权限。 返回：始终 示例： ["get", "create"]
secrets 列表 / 元素=字符串	对机密的权限。 返回：始终 示例： ["list", "set"]
tenant_id 字符串	用于对密钥保管库的请求进行身份验证的 AAD 租户 ID。 返回：始终 示例： "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
enable_purge_protection 布尔值	指定是否为此保管库启用清除保护的属性。 返回：始终 示例： false
enable_rbac_authorization 布尔值	控制如何授权数据操作的属性。 返回：始终 示例： false
enable_soft_delete 布尔值	指定是否允许 Azure Resource Manager 从密钥保管库检索机密的属性。 返回：始终 示例： true
enabled_for_deployments 布尔值	是否允许 Azure 虚拟机从密钥保管库中检索存储为机密的证书。 返回：始终 示例： false
enabled_for_disk_encryption 布尔值	是否允许 Azure 磁盘加密从保管库检索机密并解包密钥。 返回：始终 示例： false
enabled_for_template_deployment 布尔值	是否允许 Azure Resource Manager 从密钥保管库检索机密。 返回：始终 示例： false
id 字符串	保管库的资源 ID。 返回：始终 示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault"
location 字符串	保管库的位置。 返回：始终 示例： "eastus"
name 字符串	保管库的名称。 返回：始终 示例： "myVault"
network_acls 复杂	一组规则，用于管理从特定网络位置访问保管库的权限。 返回：始终
bypass 字符串	说明哪些流量可以绕过网络规则。 返回：始终 示例： "AzureServices"
default_action 字符串	当 ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 返回：始终 示例： "Allow"
ip_rules 列表 / 元素=字符串	IP 地址规则的列表。 返回：始终 示例： [{"value": "124.56.78.91/32"}]
virtual_network_rules 列表 / 元素=字符串	虚拟网络规则的列表。 返回：始终 示例： [{"id": "/subscriptions/**/resourcegroups/**/providers/microsoft.network/virtualnetworks/**/subnets/subnet01", "ignore_missing_vnet_service_endpoint": true}]
public_network_access 字符串	指定保管库是否接受来自公共互联网的流量的属性。 返回：始终 示例： "Disabled"
sku 字典	保管库的 SKU。 返回：始终
family 字符串	SKU 系列名称。 返回：始终 示例： "A"
name 字符串	SKU 名称。 返回：始终 示例： "standard"
soft_delete_retention_in_days 整数	指定保留已删除保管库的天数的属性。 返回：始终 示例： 90
tags 列表 / 元素=字符串	标签列表。 返回：成功 示例： ["foo"]
vault_uri 字符串	保管库 URI。 返回：始终 示例： "https://myVault.vault.azure.net/"

作者

• Yunge Zhu (@yungezz)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）