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

注意

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

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

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

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_keyvaultkey_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

字符串

密钥名称。如果未设置，将列出 vault_uri 中的所有密钥。

password

字符串

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

profile

字符串

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

secret

字符串

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

show_deleted_key

布尔值

设置为 true 以显示已删除的密钥。设置为 false 以显示未删除的密钥。

选项

  • false ← (默认)

  • true

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，则为必需项。

vault_uri

string / required

存储密钥的保管库 URI。

version

字符串

密钥版本。

将其设置为 current 以显示密钥的最新版本。

将其设置为 all 以列出密钥的所有版本。

将其设置为特定版本以列出密钥的特定版本。例如，fd2682392a504455b79c90dd04a1bf46。

默认值: "current"

x509_certificate_path

path

在 azure.azcollection 1.14.0 中添加

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Get latest version of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey

- name: List all versions of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey
    version: all

- name: List specific version of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey
    version: fd2682392a504455b79c90dd04a1bf46

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

- name: List deleted keys in specific key vault
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    show_deleted_key: true

返回值

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

Key

描述

keyvaults

complex

Azure Key Vault 中的密钥列表。

返回: 总是

attributes

dictionary

密钥属性。

返回: 成功

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

字符串

反映当前保险库中密钥的删除恢复级别。

如果它包含 Purgeable，则特权用户可以永久删除密钥。

否则，只有系统可以在保留期结束时清除密钥。

返回: 总是

示例: "Purgable"

updated

字符串

更新日期时间。

返回: 总是

示例: "2019-04-25T07:26:49+00:00"

key

dictionary

密钥的公共部分。

返回: 成功

crv

字符串

椭圆曲线名称。

返回: 成功

e

字符串

RSA 公共指数。

返回: 成功

n

字符串

RSA 模块。

返回: 成功

x

字符串

EC 公钥的 X 分量。

返回: 成功

y

字符串

EC 公钥的 Y 分量。

返回: 成功

kid

字符串

密钥标识符。

返回: 总是

示例: "https://myVault.vault.azure.net/keys/key1/fd2682392a504455b79c90dd04a1bf46"

managed

布尔值

如果密钥的生命周期由密钥保管库管理，则为 True。

返回: 成功

示例: true

permitted_operations

list / elements=string

密钥上允许的操作。

返回: 总是

示例: ["encrypt"]

tags

list / elements=string

密钥的标签。

返回: 总是

示例: ["foo"]

type

字符串

密钥类型。

返回: 总是

示例: "RSA"

version

字符串

密钥版本。

返回: 总是

示例: "fd2682392a504455b79c90dd04a1bf46"

作者

  • Yunge Zhu (@yungezz)