azure.azcollection.azure_rm_roleassignment_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_roleassignment_info。

azure.azcollection 0.1.2 中的新增功能

摘要

  • 获取 Azure 角色分配的事实。

要求

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

  • python >= 2.7

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

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

  • 完整的安装说明可在 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"

assignee

别名：assignee_object_id

字符串

用户、组或服务主体的对象 ID。

与 *name* 和 *id* 互斥。

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

id

字符串

要查找的角色分配的 Fqid。

如果设置，role_definition_id 和 scope 将被静默忽略。

与 assignee 和 name 互斥。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

角色分配的名称。

要求也设置 scope。

与 assignee 和 id 互斥。

password

字符串

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

profile

字符串

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

role_definition_id

字符串

角色定义的资源 ID。

scope

字符串

查询角色分配的作用域。

例如，对于订阅，使用 /subscriptions/{subscription-id}/。

对于资源组，使用 /subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name}。

对于资源，使用 /subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name}/providers/{resource-provider}/{resource-type}/{resource-name}。

默认情况下将返回从父作用域继承的所有分配，请参阅 strict_scope_match。

secret

字符串

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

strict_scope_match

布尔值

如果 strict_scope_match 为 True，则仅返回为定义的确切作用域的角色分配。

继承的角色分配将从结果中排除。

如果没有提供作用域，则该选项将被静默忽略。

选项

  • false ← (默认)

  • true

subscription_id

字符串

您的 Azure 订阅 ID。

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Get role assignments for specific service principal
  azure_rm_roleassignment_info:
    assignee: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments for specific scope that matches specific role definition
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    role_definition_id: /subscriptions/xxx-sub-guid-xxx/providers/Microsoft.Authorization/roleDefinitions/xxx-role-guid-xxxx

- name: Get role assignments for specific scope with no inherited assignments
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    strict_scope_match: true

- name: Get role assignments by name
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    name: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments by id
  azure_rm_roleassignment_info:
    id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

返回值

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

键

描述

roleassignments

复杂

角色分配列表。

返回：始终

id

字符串

角色分配的 ID。

返回：始终

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

name

字符串

角色分配的名称。

返回：始终

示例： "myRoleAssignment"

principal_id

字符串

分配给的角色的委托人 ID。

返回：始终

示例： "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

principal_type

字符串

分配给的角色的委托人类型。

返回：始终

示例： "ServicePrincipal"

role_definition_id

字符串

分配给 principal_id 的角色定义 ID。

返回：始终

示例： "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

scope

字符串

角色分配的作用域。

返回：始终

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

type

字符串

角色分配的类型。

返回：始终

示例： "custom"

作者

  • 朱韵歌(@yungezz)

  • Paul Aiton(@paultaiton)