azure.azcollection.azure_rm_lock 模块 – 管理 Azure 锁定

注意

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

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

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

要在剧本中使用它，请指定： azure.azcollection.azure_rm_lock。

azure.azcollection 0.1.2 中的新增功能

摘要

  • 创建或删除 Azure 锁定。

  • 要创建或删除管理锁定，您必须具有对 Microsoft.Authorization/* 或 Microsoft.Authorization/locks/* 操作的访问权限。

  • 在内置角色中，只有所有者和用户访问管理员被授予这些操作权限。

要求

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

  • 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"

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

level

字符串

锁级别类型。

选项

  • "can_not_delete"

  • "read_only"

log_mode

字符串

父参数。

log_path

字符串

父参数。

managed_resource_id

字符串

管理指定资源 ID 的锁。

与resource_group互斥。

如果未指定managed_resource_id或resource_group，则为当前订阅管理锁。

订阅的‘/subscriptions/{subscriptionId}’。

资源组的‘/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}’。

资源的‘/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{namespace}/{resourceType}/{resourceName}’。

name

字符串 / 必需

锁的名称。

notes

字符串

关于锁的说明。最多 512 个字符。

password

字符串

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

profile

字符串

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

resource_group

字符串

管理命名资源组的锁。

与managed_resource_id互斥。

如果未指定managed_resource_id或resource_group，则为当前订阅管理锁。

secret

字符串

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

state

字符串

锁的状态。

使用present创建或更新锁，使用absent删除锁。

选项

  • "absent"

  • "present" ← (默认)

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: Create a lock for a resource
  azure_rm_lock:
      managed_resource_id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM
      name: myLock
      level: read_only

- name: Create a lock for a resource group
  azure_rm_lock:
      managed_resource_id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup
      name: myLock
      level: read_only

- name: Create a lock for a resource group
  azure_rm_lock:
      resource_group: myResourceGroup
      name: myLock
      notes: description_lock
      level: read_only

- name: Create a lock for a subscription
  azure_rm_lock:
      name: myLock
      level: read_only

返回值

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

键

描述

id

字符串

锁的资源 ID。

返回：成功

示例："/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/locks/keep"

作者

  • 周宇威 (@yuwzho)