azure.azcollection.azure_rm_keyvault 模块 – 管理密钥保管库实例

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 创建、更新和删除密钥保管库的实例。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

access_policies

列表 / 元素=字典

一个 0 到 16 个身份的数组，这些身份可以访问密钥保管库。

数组中的所有身份必须使用与密钥保管库的租户 ID 相同的租户 ID。

application_id

字符串

代表主体发出请求的客户端的应用程序 ID。

certificates

列表 / 元素=字符串

证书的权限列表。

选择

  • "get"

  • "list"

  • "delete"

  • "create"

  • "import"

  • "update"

  • "managecontacts"

  • "getissuers"

  • "listissuers"

  • "setissuers"

  • "deleteissuers"

  • "manageissuers"

  • "recover"

  • "purge"

  • "backup"

  • "restore"

keys

列表 / 元素=字符串

密钥的权限列表。

选择

  • "encrypt"

  • "decrypt"

  • "wrapkey"

  • "unwrapkey"

  • "sign"

  • "verify"

  • "get"

  • "list"

  • "create"

  • "update"

  • "import"

  • "delete"

  • "backup"

  • "restore"

  • "recover"

  • "purge"

object_id

字符串 / 必需

密钥保管库的 Azure Active Directory 租户中用户、服务主体或安全组的对象 ID。

对于访问策略列表，对象 ID 必须是唯一的。

请注意，这不是应用程序 ID。可以通过运行“az ad sp show –id <应用程序 ID>”获取对象 ID。

secrets

列表 / 元素=字符串

机密的权限列表。

选择

  • "get"

  • "list"

  • "set"

  • "delete"

  • "backup"

  • "restore"

  • "recover"

  • "purge"

storage

列表 / 元素=字符串

存储帐户的权限列表。

tenant_id

字符串

应该用于对密钥保管库进行身份验证请求的 Azure Active Directory 租户 ID。

如果未指定，将使用当前的密钥保管库 tenant_id 值。

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"

append_tags

布尔值

用于控制 tags 字段是规范的还是仅附加到现有标签。

当为规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。

选择

  • false

  • true ← （默认）

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

enable_purge_protection

布尔值

属性，指定是否为此保管库启用防止清除的保护。

选择

  • false ← (默认)

  • true

enable_rbac_authorization

布尔值

控制数据操作授权方式的属性。

当 enable_rbac_authorization=true 时，密钥保管库将使用基于角色的访问控制 (RBAC) 来授权数据操作，并且将忽略保管库属性中指定的访问策略。

当 enable_rbac_authorization=false 时，密钥保管库将使用保管库属性中指定的访问策略，并且将忽略 Azure 资源管理器上存储的任何策略。

如果为空或未指定，则此属性的值将不会更改。

选择

  • false

  • true

enable_soft_delete

布尔值

指定是否为此密钥保管库启用软删除功能的属性。

选择

  • false

  • true ← （默认）

enabled_for_deployment

布尔值

属性，指定是否允许 Azure 虚拟机从密钥保管库检索存储为机密的证书。

选择

  • false

  • true

enabled_for_disk_encryption

布尔值

属性，指定是否允许 Azure 磁盘加密从保管库检索机密并解包密钥。

选择

  • false

  • true

enabled_for_template_deployment

布尔值

属性，指定是否允许 Azure 资源管理器从密钥保管库检索机密。

选择

  • false

  • true

location

字符串

资源位置。 如果未设置，则将使用资源组中的位置作为默认值。

log_mode

字符串

父参数。

log_path

字符串

父参数。

network_acls

字典

一组规则，用于管理从特定网络位置访问保管库的权限。

bypass

字符串

指示哪些流量可以绕过网络规则。

如果未指定，则默认值为“AzureServices”。

选择

  • "AzureServices" ← (默认)

  • "None"

default_action

字符串

当 ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。

仅在评估 bypass 属性后使用。

选择

  • "Allow"

  • "Deny"

ip_rules

列表 / 元素=字典

IP 地址规则列表。

value

字符串

以 CIDR 表示法表示的 IPv4 地址范围。

例如 124.56.78.91 (简单 IP 地址) 或 124.56.78.0/24 (所有以 124.56.78 开头的地址)。

virtual_network_rules

列表 / 元素=字典

虚拟网络规则列表。

id

字符串

vnet 子网的完整资源 ID。

ignore_missing_vnet_service_endpoint

布尔值

属性，指定 NRP 是否忽略对父子网是否配置了 serviceEndpoints 的检查。

选择

  • false

  • true

password

字符串

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

profile

字符串

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

public_network_access

字符串

属性，指定保管库是否接受来自公共 Internet 的流量。

选择

  • "Disabled"

  • "Enabled"

recover_mode

布尔值

在恢复模式下创建保管库。

选择

  • false

  • true

resource_group

字符串 / 必需

服务器所属的资源组的名称。

secret

字符串

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

sku

字典

SKU 详细信息。

family

字符串 / 必需

SKU 系列名称。

name

字符串 / 必需

SKU 名称，用于指定密钥保管库是标准保管库还是高级保管库。

选择

  • "standard"

  • "premium"

soft_delete_retention_in_days

整数

属性，指定保留已删除保管库的天数。

state

字符串

断言 KeyVault 的状态。 使用 present 创建或更新 KeyVault，使用 absent 删除它。

选择

  • "absent"

  • "present" ← (默认)

subscription_id

字符串

您的 Azure 订阅 ID。

tags

字典

字符串:字符串对的字典，用于将元数据分配给对象。

对象上的元数据标记将使用提供的任何值进行更新。

要删除标记，请将 append_tags 选项设置为 false。

当前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。

Azure Front Door 不支持使用

Azure Automation 和 Azure CDN 仅支持资源上的 15 个标记。

tenant

字符串

Azure 租户 ID。 使用服务主体进行身份验证时使用。

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

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

如果定义了 x509_certificate_path，则为必填项。

vault_name

字符串 / 必需

保管库的名称。

vault_tenant

字符串

应该用于对密钥保管库进行身份验证请求的 Azure Active Directory 租户 ID。

x509_certificate_path

路径

在 azure.azcollection 1.14.0 中添加

用于创建 PEM 格式的服务主体的 X509 证书的路径。

该证书必须附加到私钥。

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

注释

注意

  • 要使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或 playbook 之前使用 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: Create instance of Key Vault
  azure_rm_keyvault:
    resource_group: myResourceGroup
    vault_name: samplekeyvault
    enabled_for_deployment: true
    enable_rbac_authorization: true
    vault_tenant: 72f98888-8666-4144-9199-2d7cd0111111
    sku:
      name: standard
      family: A
    access_policies:
      - tenant_id: 72f98888-8666-4144-9199-2d7cd0111111
        object_id: 99998888-8666-4144-9199-2d7cd0111111
        keys:
          - get
          - list

返回值

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

Key

描述

id

字符串

密钥保管库的 Azure 资源管理器资源 ID。

返回： 始终

示例： "id"

作者

  • Zim Kalinowski (@zikalino)