azure.azcollection.azure_rm_diskencryptionset_info 模块 – 获取磁盘加密集事实

注意

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

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

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

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

azure.azcollection 1.9.0 中的新增功能

概要

• 获取特定磁盘加密集或给定资源组中所有集合的事实。

需求

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

• python >= 2.7

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

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

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

参数

参数	注释
ad_user 字符串	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 列表 / 元素=字符串	通过提供标签列表来限制结果。将标签格式化为“键”或“键：值”。
tenant 字符串	Azure租户ID。使用服务主体进行身份验证时使用。
thumbprint 字符串 azure.azcollection 1.14.0版本中添加	在x509_certificate_path中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了x509_certificate_path，则为必需。
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 facts for one disk encryption set
  azure_rm_diskencryptionset_info:
    resource_group: myResourceGroup
    name: mydiskencryptionset
    tags:
      - key:value

- name: Get facts for all disk encryption sets in resource group
  azure_rm_diskencryptionset_info:
    resource_group: myResourceGroup

返回值

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

键

描述

diskencryptionsets 列表 / 元素=字典

获取磁盘加密集列表。 返回：始终 示例： [{"active_key": {"key_url": "https://myvault.vault.azure.net/keys/Key1/e65090b268ec4c3ba1a0f7a473005768", "source_vault": {"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/ Microsoft.KeyVault/vaults/myvault"}}, "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/ Microsoft.Compute/diskEncryptionSets/mydiskencryptionset", "identity": {"principal_id": "d3abec0a-5818-4bbd-8300-8014198124ca", "tenant_id": "7268bab5-aabd-44f9-915f-6bf864e879c6", "type": "SystemAssigned"}, "location": "eastus", "name": "mydiskencryptionset", "provisioning_state": "Succeeded", "tags": {"key1": "value1"}, "type": "Microsoft.Compute/diskEncryptionSets"}]

作者

• Aparna Patil (@techcon65)

集合链接

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