azure.azcollection.azure_rm_batchaccount 模块 – 管理 Azure 上的 Batch 帐户

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 创建、更新和删除 Azure Batch 帐户实例。

需求

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

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

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

auto_storage_account

任意

与 Batch 帐户关联的现有存储帐户。

它可以是位于同一资源组中的存储帐户名称。

它可以是存储帐户 ID。例如，“/subscriptions/{subscription_id}/resourceGroups/ {resource_group}/providers/Microsoft.Storage/storageAccounts/{name}”。

它可以是一个包含存储帐户的 *name* 和 *resource_group* 的字典。

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

identity

字典

此资源的身份。

type

字符串

托管身份的类型

选项

  • "SystemAssigned"

  • "UserAssigned"

  • "None" ← (默认值)

user_assigned_identity

字符串

与此资源关联的用户分配的托管身份

key_vault

任意

与 Batch 帐户关联的现有密钥保管库。

它可以是位于同一资源组中的密钥保管库名称。

它可以是密钥保管库 ID。例如，“/subscriptions/{subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.KeyVault/vaults/{name}”。

它可以是一个字典，包含密钥保管库的 *name* 和 *resource_group*。

location

字符串

指定资源存在的受支持的 Azure 位置。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必填

Batch 帐户的名称。

password

字符串

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

pool_allocation_mode

字符串

Batch 帐户的池分配模式。

选项

  • "batch_service" ← (默认值)

  • "user_subscription"

profile

字符串

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

resource_group

字符串 / 必填

创建 Batch 帐户的资源组的名称。

secret

字符串

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

state

字符串

断言 Batch 帐户的状态。

使用present创建或更新 Batch 帐户，使用absent删除它。

选项

  • "present" ← (默认值)

  • "absent"

subscription_id

字符串

您的 Azure 订阅 ID。

tags

字典

要作为元数据分配给对象的字符串：字符串对的字典。

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

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

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

Azure 前端门户不支持使用

Azure 自动化和 Azure CDN 每个资源只支持 15 个标签。

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 Batch Account
  azure_rm_batchaccount:
    resource_group: MyResGroup
    name: mybatchaccount
    location: eastus
    auto_storage_account:
      name: mystorageaccountname
    pool_allocation_mode: batch_service

返回值

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

键

描述

account_endpoint

字符串

用于与 Batch 服务交互的帐户端点。

返回：始终

示例："sampleacct.westus.batch.azure.com"

id

字符串

Batch 帐户的 ID。

返回：始终

示例："/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Batch/batchAccounts/sampleacct"

作者

  • 易俊怡 (@JunyiYi)