azure.azcollection.azure_rm_batchaccountpool_info 模块 – 获取 Batch 帐户池的事实

注意

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

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

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

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

azure.azcollection 3.0.0 中的新增功能

概要

  • 获取 Batch 帐户池的事实。

要求

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

  • python >= 2.7

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

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

  • 完整的安装说明可在 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，否则将选择第一个订阅。

msi 在 Ansible 2.6 中添加。

选择

  • "auto" ← (默认)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

batch_account_name

字符串 / 必需

Batch 帐户的名称。

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。

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 中的配置文件，或者在运行任务或 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: Get the Batch Account Pool by name
  azure_rm_batchaccountpool_info:
    resource_group: MyResGroup
    batch_account_name: batchname01
    name: mypool01

- name: List the Batch Account Pool
  azure_rm_batchaccountpool_info:
    resource_group: MyResGroup
    batch_account_name: batchname01

返回值

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

键

描述

batch_account_pool

字典

包含有关批处理帐户中的池的信息。

返回： 始终

示例： {"allocation_state": "Steady", "allocation_state_transition_time": "2024-11-05T08:58:16.803138Z", "batch_account_name": "fredbatch02", "creation_time": "2024-11-05T08:58:15.399345Z", "current_dedicated_nodes": 0, "current_low_priority_nodes": 0, "deployment_configuration": {"virtual_machine_configuration": {"image_reference": {"offer": "ubuntu-hpc", "publisher": "microsoft-dsvm", "sku": "2204", "version": "latest"}, "node_agent_sku_id": "batch.node.ubuntu 22.04", "node_placement_configuration": {"policy": "Regional"}, "os_disk": {"caching": "None", "managed_disk": {"storage_account_type": "Premium_LRS"}}}}, "etag": "0x8DCFD77FC345CFE", "id": "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Batch/batchAccounts/batch01/pools/pool01", "inter_node_communication": "Disabled", "last_modified": "2024-11-05T08:58:15.399347Z", "name": "poolfredbatch02--002", "network_configuration": {"dynamic_vnet_assignment_scope": "None", "enable_accelerated_networking": false, "endpoint_configuration": {"inbound_nat_pools": [{"backend_port": 33, "frontend_port_range_end": 49999, "frontend_port_range_start": 1, "name": "nat02", "protocol": "UDP"}]}, "public_ip_address_configuration": {"provision": "BatchManaged"}, "subnet_id": "/subscriptions/xxx-xxx/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet01/subnets/default"}, "provisioning_state": "Succeeded", "provisioning_state_transition_time": "2024-11-05T08:58:15.399345Z", "resize_operation_status": {"node_deallocation_option": "Requeue", "resize_timeout": "PT15M", "start_time": "2024-11-05T08:58:15.399317Z", "target_dedicated_nodes": 0}, "resource_group": "v-xisuRG06", "scale_settings": {"fixed_scale": {"resize_timeout": "PT15M", "target_dedicated_nodes": 0, "target_low_priority_nodes": 0}}, "target_node_communication_mode": "Default", "task_scheduling_policy": {"node_fill_type": "Pack"}, "task_slots_per_node": 1, "type": "Microsoft.Batch/batchAccounts/pools", "upgrade_policy": {"automatic_os_upgrade_policy": {"disable_automatic_rollback": false, "enable_automatic_os_upgrade": false, "os_rolling_upgrade_deferral": false, "use_rolling_upgrade_policy": false}, "mode": "Manual", "rolling_upgrade_policy": {"max_batch_instance_percent": 20, "max_unhealthy_instance_percent": 20, "max_unhealthy_upgraded_instance_percent": 20, "pause_time_between_batches": "P0D", "rollback_failed_instances_on_policy_breach": false}}, "vm_size": "STANDARD_D2S_V3"}

作者

  • xuzhang3 (@xuzhang3)

  • Fred Sun (@Fred-sun)