azure.azcollection.azure_rm_keyvaultsecret_info 模块 – 获取 Azure Key Vault 密钥事实

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

• 获取 Azure Key Vault 密钥的事实。

要求

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

• python >= 2.7

• 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

• 集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 集合中模块的主机上

• 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 找到

参数

参数	注释
ad_user 字符串	活动目录用户名。使用此项代替服务主体进行活动目录用户身份验证。
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，否则选择第一个订阅。 Ansible 2.6 中添加了 msi。 选项 "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 字符串	密钥名称。如果未设置，将列出 vault_uri 中的所有密钥。
password 字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
secret 字符串	Azure 客户机密钥。使用服务主体进行身份验证时使用。
show_deleted_secret 布尔值	设置为show_delete_secret=true 以显示已删除的密钥。设置为show_deleted_secret=false 以显示未删除的密钥。 选项 false ← (默认) true
subscription_id 字符串	您的 Azure 订阅 ID。
tags 列表 / 元素=字符串	通过提供标签列表来限制结果。将标签格式化为“键”或“键：值”。
tenant 字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
thumbprint 字符串 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了x509_certificate_path，则为必需。
vault_uri 字符串 / 必需	存储密钥的保管库 uri。
version 字符串	密钥版本。 将其设置为current 以显示密钥的最新版本。 将其设置为all 以列出密钥的所有版本。 将其设置为特定版本以列出密钥的特定版本。例如：fd2682392a504455b79c90dd04a1bf46 默认： "current"
x509_certificate_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 latest version of specific secret
  azure_rm_keyvaultsecret_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: mySecret

- name: List all versions of specific secret
  azure_rm_keyvaultsecret_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: mySecret
    version: all

- name: List specific version of specific secret
  azure_rm_keyvaultsecret_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: mySecret
    version: fd2682392a504455b79c90dd04a1bf46

- name: List all secrets in specific key vault
  azure_rm_keyvaultsecret_info:
    vault_uri: "https://myVault.vault.azure.net"

- name: List deleted secrets in specific key vault
  azure_rm_keyvaultsecret_info:
    vault_uri: "https://myVault.vault.azure.net"
    show_deleted_secret: true

返回值

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

键	描述
secrets 复杂	Azure Key Vault 中的密钥列表。 返回：始终
attributes 字典	密钥属性。 返回：成功
created 字符串	创建时间。 返回：始终 示例： "2019-04-25T07:26:49+00:00"
enabled 字符串	指示密钥是否已启用。 返回：始终 示例： "True"
expires 字符串	过期时间。 返回：成功 示例： "2019-04-25T07:26:49+00:00"
not_before 字符串	生效时间。 返回：成功 示例： "2019-04-25T07:26:49+00:00"
recovery_level 字符串	反映当前对当前保管库中密钥生效的删除恢复级别。 如果包含“可清除”，则特权用户可以永久删除密钥， 否则，只有系统可以在保留期结束时清除密钥。 返回：始终 示例： "Recoverable+Purgeable"
updated 字符串	更新时间。 返回：始终 示例： "2019-04-25T07:26:49+00:00"
content_type 字符串	内容类型（可选） 返回：始终 示例： "mysecrettype"
secret 字符串	密钥值。 返回：始终 示例： "mysecretvault"
sid 字符串	密钥标识符。 返回：始终 示例： "https://myVault.vault.azure.net/flexsecret/secret1/fd2682392a504455b79c90dd04a1bf46"
tags 字典	密钥的标签。 返回：始终 示例： {"delete": "on-exit"}
version 字符串	密钥版本。 返回：始终 示例： "fd2682392a504455b79c90dd04a1bf46"

作者

• Jose Angel Munoz (@imjoseangel)

收藏链接

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