Microsoft Azure SDK for Python

这是Microsoft Azure Batch管理客户端库。此软件包已在Python 3.7+上进行了测试。要获取Azure库的完整视图，请参阅azure sdk python发布。

免责声明

Azure SDK Python 包对 Python 2.7 的支持已于 2022 年 1 月 1 日结束。有关更多信息和建议，请参阅 https://github.com/Azure/azure-sdk-for-python/issues/20691

入门指南

先决条件

• 使用此包需要 Python 3.7 或更高版本。
• Azure 订阅

安装包

pip install azure-mgmt-batch
pip install azure-identity

身份验证

默认情况下，Azure Active Directory 令牌身份验证依赖于以下环境变量的正确配置。

• AZURE_CLIENT_ID 用于 Azure 客户端 ID。
• AZURE_TENANT_ID 用于 Azure 租户 ID。
• AZURE_CLIENT_SECRET 用于 Azure 客户端密钥。

此外，Azure 订阅 ID 可以通过环境变量 AZURE_SUBSCRIPTION_ID 进行配置。

以上配置完成后，客户端可以通过以下代码进行身份验证

from azure.identity import DefaultAzureCredential
from azure.mgmt.batch import BatchManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = BatchManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)

示例

此包的代码示例可以在以下位置找到

• 在 docs.microsoft.com 上搜索批量管理
• Azure Python 管理 SDK 示例存储库

故障排除

下一步

提供反馈

如果您遇到任何错误或有建议，请在项目的 问题 部分提交问题。

版本历史记录

18.0.0 (2024-09-25)

新增功能

• 客户端 BatchManagementClient 添加了操作组 network_security_perimeter
• 模型 Application 在方法 __init__ 中添加了参数 tags
• 模型 ApplicationPackage 在方法 __init__ 中添加了参数 tags
• 模型 Certificate 在方法 __init__ 中添加了参数 tags
• 模型 CertificateCreateOrUpdateParameters 在方法 __init__ 中添加了参数 tags
• 模型 DetectorResponse 在方法 __init__ 中添加了参数 tags
• 模型 ImageReference 添加了属性 shared_gallery_image_id
• 模型 ImageReference 添加了属性 community_gallery_image_id
• 模型 ManagedDisk 添加了属性 security_profile
• 模型 Pool 在方法 __init__ 中添加了参数 tags
• 模型 PrivateEndpointConnection 在方法 __init__ 中添加了参数 tags
• 模型 PrivateLinkResource 在方法 __init__ 中添加了参数 tags
• 模型 ProxyResource 添加了属性 system_data
• 模型 ProxyResource 添加了属性 additional_properties
• 枚举 PublicNetworkAccessType 添加了成员 SECURED_BY_PERIMETER
• 模型 Resource 添加了属性 system_data
• 模型 TaskContainerSettings 添加了属性 container_host_batch_bind_mounts
• 添加了模型 AccessRule
• 添加了枚举 AccessRuleDirection
• 添加了模型 AccessRuleProperties
• 添加了模型 AccessRulePropertiesSubscriptionsItem
• 添加了模型 AzureProxyResource
• 添加了模型 AzureResource
• 添加了模型 ContainerHostBatchBindMountEntry
• 添加了枚举 ContainerHostDataPath
• 添加了枚举 CreatedByType
• 添加了模型 ErrorAdditionalInfo
• 添加了模型 ErrorDetail
• 添加了模型 ErrorResponse
• 添加了枚举 IssueType
• 添加了模型 NetworkSecurityPerimeter
• 添加了模型 NetworkSecurityPerimeterConfiguration
• 添加了模型 NetworkSecurityPerimeterConfigurationListResult
• 添加了模型 NetworkSecurityPerimeterConfigurationProperties
• 添加了枚举 NetworkSecurityPerimeterConfigurationProvisioningState
• 添加了模型 NetworkSecurityProfile
• 添加了模型 ProvisioningIssue
• 添加了模型 ProvisioningIssueProperties
• 添加了模型 ResourceAssociation
• 添加了枚举 ResourceAssociationAccessMode
• 添加了枚举 SecurityEncryptionTypes
• 添加了枚举 SecurityTypes
• 添加了枚举 Severity
• 添加了模型 SystemData
• 添加了模型 VMDiskSecurityProfile
• 添加了模型 NetworkSecurityPerimeterOperations

重大更改

• 模型 DeploymentConfiguration 删除或重命名了其实例变量 cloud_service_configuration
• 模型 ProxyResource 删除或重命名了其实例变量 etag
• 模型 Resource 删除或重命名了其实例变量 location
• 模型 Resource 删除或重命名了其实例变量 tags
• 删除或重命名了模型 CloudServiceConfiguration
• 删除或重命名了方法 LocationOperations.list_supported_cloud_service_skus

17.3.0 (2024-03-19)

新增功能

• 模型 Pool 添加了新的参数 upgrade_policy
• 模型 SupportedSku 添加了新的参数 batch_support_end_of_life

17.2.0 (2023-12-18)

新增功能

• 模型 OSDisk 添加了新的参数 caching
• 模型 OSDisk 添加了新的参数 disk_size_gb
• 模型 OSDisk 添加了新的参数 managed_disk
• 模型 OSDisk 添加了新的参数 write_accelerator_enabled
• 模型 Pool 添加了新的参数 resource_tags
• 模型 VirtualMachineConfiguration 添加了新的参数 security_profile
• 模型 VirtualMachineConfiguration 添加了新的参数 service_artifact_reference

17.1.0 (2023-07-21)

新增功能

• 模型 NetworkConfiguration 添加了新的参数 enable_accelerated_networking
• 模型 VMExtension 添加了新的参数 enable_automatic_upgrade
• 模型 ContainerConfiguration 允许两个可能的值：dockerCompatible 和 criCompatible，而不是固定的值 dockerCompatible

17.0.0 (2022-11-23)

新增功能

• 模型 NetworkConfiguration 添加了新的参数 dynamic_vnet_assignment_scope
• 模型 Pool 添加了新的参数 current_node_communication_mode
• 模型 Pool 添加了新的参数 target_node_communication_mode
• 模型 PrivateLinkServiceConnectionState 添加了新的参数 actions_required

重大更改

• 模型 CIFSMountConfiguration 添加了一个新的必填参数 user_name
• 模型 CIFSMountConfiguration 不再具有参数 username
• 模型 NetworkConfiguration 不再具有参数 dynamic_v_net_assignment_scope
• 模型 PrivateLinkServiceConnectionState 不再具有参数 action_required

16.2.0 (2022-06-06)

功能

• 添加了操作 PrivateEndpointConnectionOperations.begin_delete
• 模型 BatchAccount 添加了新的参数 network_profile
• 模型 BatchAccount 添加了新的参数 node_management_endpoint
• 模型 BatchAccountCreateParameters 添加了新的参数 network_profile
• 模型 BatchAccountUpdateParameters 添加了新的参数 network_profile
• 模型 BatchAccountUpdateParameters 添加了新的参数 public_network_access
• 模型 PrivateEndpointConnection 添加了新的参数 group_ids

16.1.0 (2022-02-24)

功能

• 添加了操作 BatchAccountOperations.get_detector
• 添加了操作 BatchAccountOperations.list_detectors
• 模型 NetworkConfiguration 添加了新的参数 dynamic_v_net_assignment_scope

16.0.0 (2021-07-30)

功能

• 模型 BatchAccount 添加了新的参数 allowed_authentication_modes
• 模型 AutoStorageBaseProperties 添加了新的参数 node_identity_reference
• 模型 AutoStorageBaseProperties 添加了新的参数 authentication_mode
• 模型 AzureBlobFileSystemConfiguration 添加了新的参数 identity_reference
• 模型 BatchAccountUpdateParameters 添加了新的参数 allowed_authentication_modes
• 模型 ContainerRegistry 添加了新的参数 identity_reference
• 模型 Operation 添加了新的参数 is_data_action
• 模型 BatchAccountCreateParameters 添加了新的参数 allowed_authentication_modes
• 模型 AutoStorageProperties 添加了新的参数 node_identity_reference
• 模型 AutoStorageProperties 添加了新的参数 authentication_mode
• 模型 ResourceFile 添加了新的参数 identity_reference
• 模型 VirtualMachineConfiguration 添加了新的参数 os_disk
• 添加了操作 BatchAccountOperations.list_outbound_network_dependencies_endpoints
• 添加了操作 LocationOperations.list_supported_cloud_service_skus
• 添加了操作 LocationOperations.list_supported_virtual_machine_skus

破坏性变更

• 将 BatchManagement 重命名为 BatchManagementClient

15.0.0 (2021-02-01)

• 修复更改日志

15.0.0b1 (2021-01-28)

功能

• 在池上为 VirtualMachineConfiguration 添加了新的扩展属性，用于指定节点的虚拟机扩展
• 在 VirtualMachineConfiguration 上添加了新的属性 node_placement_configuration，以指定可用区
• 在 Pool 上添加了新的身份属性，用于指定托管身份
• 在 BatchAccountIdentity 上添加了新的 user_assigned_identities，用于指定用户管理的身份
• 添加了证书操作方法 PoolOperations.create
• 添加了证书操作方法 CertificateOperations.create

破坏性变更

• 移除了证书操作方法 PoolOperations.begin_create。证书操作不是长时间运行的操作，因此这是不正确的。
• 移除了证书操作方法 CertificateOperations.begin_create。证书操作不是长时间运行的操作，因此这是不正确的。

14.0.0 (2020-12-22)

• GA 版本

14.0.0b1 (2020-10-23)

这是测试预览版本。

本版本使用新一代代码生成器，引入了重要的破坏性变更，但也引入了重要的新功能（如统一身份验证和异步编程）。

一般破坏性变更

• 凭证系统已完全重造

  • azure.common.credentials 或 msrestazure.azure_active_directory 实例不再受支持，请使用 azure-identity 类：[https://pypi.ac.cn/project/azure-identity/](https://pypi.ac.cn/project/azure-identity/)
  • credentials 参数已重命名为 credential

• 客户端上的 config 属性不再存在，配置应作为 kwarg 传递。例如：MyClient(credential, subscription_id, enable_logging=True)。有关支持选项的完整集合，请参阅 [azure-core 初始化文档中的参数接受](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

• 不能再导入 version 模块，请使用 __version__ 代替

• 以前返回 msrest.polling.LROPoller 的操作现在返回 azure.core.polling.LROPoller，并带有 begin_ 前缀。

• 异常树已简化，大多数异常现在是 azure.core.exceptions.HttpResponseError（已删除 CloudError）。

• 大多数操作 kwarg 都已更改。其中一些最显著的

  • raw 已删除。等效功能可以通过使用 cls 找到，这是一个回调，将提供对内部 HTTP 响应的访问，供高级用户使用
  • 有关支持选项的完整集合，请参阅 [azure-core 请求文档中的参数接受](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

一般新功能

• 支持使用 typing 进行类型注解。SDKs 已准备好使用 mypy。
• 此客户端现在具有稳定且官方的异步支持。检查您的包中的 aio 命名空间以查找异步客户端。
• 此客户端现在原生支持 OpenCensus 或 OpenTelemetry 等跟踪库。有关概述，请参阅此 [跟踪快速入门](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry)。

9.0.0 (2020-05-29)

REST API 版本

• 本版本针对 REST API 版本 2020-05-01。

功能

• 通过在 BatchAccount 上的新 public_network_access 属性中添加了能够访问 Batch DataPlane API 而无需为帐户创建公共 DNS 条目的功能。
• 添加了新的 PrivateLinkResource 和 PrivateEndpointConnection 资源类型。这两个类型都仅在将 BatchAccount 上的 public_network_access 属性设置为 Disabled 时使用。
  • 当 public_network_access 设置为 Disabled 时，在该帐户中可见一个新 PrivateLinkResource，可用于通过您的 VNET 中的 ARM Private Endpoint 连接到帐户。
• 通过使用 VirtualMachineConfiguration 的新 disk_encryption_configuration 属性，现在可以加密 ComputeNode 磁盘驱动器。
• [破坏性] ImageReference 的 id 属性现在只能引用共享映像库图像。
• [破坏性] 现在可以通过 NetworkConfiguration 的新 public_ip_configuration 属性来部署池而无需公共 IP。
  • NetworkConfiguration 的 public_ips 属性已移动到 PublicIPAddressConfiguration。此属性只能在 IPAddressProvisioningType 为 UserManaged 时指定。
• 向 BatchAccount 添加了新的 identity 属性，类型为 BatchAccountIdentity。这可以用来配置如何在 Batch 帐户内部加密客户数据。
  • 这个新属性可以在创建和更新时在账户级别进行配置，通过在BatchAccountCreateParameters和BatchAccountUpdateParameters上新增的identity属性来实现。

修复内容

• [破坏性更改] 将标签从创建和更新池参数的参数移动到BatchAccountCreateParameters和BatchAccountUpdateParameters中，以正确反映REST API。

8.0.1（2020-05-26）[已弃用]

注意事项

• 此版本针对了一个无效的REST API。此版本不遵守相关REST API合约。

错误修复

• 由于Swagger规范中的错误导致验证失败，修复了私有端点连接的获取和更新方法中存在的问题。建议使用9.0版本或更高版本以利用此版本中添加的功能。

8.0.0（2020-04-10）[已弃用]

注意事项

• 此版本针对了一个无效的REST API。目前，私有端点的get()和update()函数无法正常工作。建议使用9.0版本或更高版本以利用此版本中添加的功能。

REST API 版本

• 此版本针对REST API版本2020-03-01。

功能

• 通过在 BatchAccount 上的新 public_network_access 属性中添加了能够访问 Batch DataPlane API 而无需为帐户创建公共 DNS 条目的功能。
• 添加了新的 PrivateLinkResource 和 PrivateEndpointConnection 资源类型。这两个类型都仅在将 BatchAccount 上的 public_network_access 属性设置为 Disabled 时使用。
  • 当 public_network_access 设置为 Disabled 时，在该帐户中可见一个新 PrivateLinkResource，可用于通过您的 VNET 中的 ARM Private Endpoint 连接到帐户。
• 通过使用 VirtualMachineConfiguration 的新 disk_encryption_configuration 属性，现在可以加密 ComputeNode 磁盘驱动器。
• [破坏性] ImageReference 的 id 属性现在只能引用共享映像库图像。
• [破坏性] 现在可以通过 NetworkConfiguration 的新 public_ip_configuration 属性来部署池而无需公共 IP。
  • NetworkConfiguration 的 public_ips 属性已移动到 PublicIPAddressConfiguration。此属性只能在 IPAddressProvisioningType 为 UserManaged 时指定。

7.0.0 (2019-08-05)

• 通过新的public_ips属性，现在可以在NetworkConfiguration上指定一组公共IP地址。这保证了池中的节点将具有用户提供的IP列表中的一个IP地址。
• 现在可以通过Pool上的mount_configuration属性在每个池节点上挂载远程文件系统。
• 现在可以通过引用ARM ID来通过ImageReference的id属性指定共享镜像库中的镜像。
• [破坏性更改] 如果未指定，现在StartTask上的wait_for_success的默认值是True（之前是False）。
• [破坏性更改] 如果未指定，现在AutoUserSpecification上的scope的默认值始终是Pool（在Windows节点上是Task，在Linux节点上是Pool）。
• 破坏性更改 模型签名现在只使用关键字参数语法。每个位置参数都必须重写为关键字参数。
• 枚举类型现在使用“str”混合（class AzureEnum(str, Enum)）来改进遇到未识别枚举值时的行为。

6.0.0 (2019-01-14)

• • [破坏性更改] 资源文件改进

    • 在ResourceFile中添加了指定整个Azure存储容器的能力。

    • 新的属性HttpUrl替换了BlobSource。这可以是指向任何HTTP URL。之前，这必须是Azure Blob Storage URL。

    • • 在构建ResourceFile时，您现在可以从以下选项中选择一个：

        • HttpUrl：指定一个指向要下载的特定文件的HTTP URL。
        • StorageContainerUrl：指定Azure存储容器的URL。所有与存储容器中的BlobPrefix匹配的blob都将被下载。
        • AutoStorageContainerName：指定在已注册的批处理自动存储账户中的容器名称。所有与存储容器中的BlobPrefix匹配的blob都将被下载。

• [破坏性更改] 从VirtualMachineConfiguration中删除了OSDisk属性。此属性不再受支持。

• [破坏性更改] Application不再具有Packages属性，而是可以通过新的ApplicationPackage.List API检索包。

• [破坏性更改] TargetOsVersion现在是OsVersion，并且CurrentOsVersion不再在CloudServiceConfiguration上受支持。

• 通过WindowsUserConfiguration.LoginMode添加了对Windows池创建具有特定登录模式（即Batch或Interactive）的用户的支持。

• 在创建池时添加了对ContainerConfiguration的支持。

5.0.1 (2018-05-25)

错误修复

• sdist与wheel 0.31.0的兼容性
• msrestazure依赖版本范围

5.0.0 (2017-11-13)

• 批处理池现在是可以使用新的客户端.PoolOperations创建、更新和管理ARM资源。
• 批处理证书现在已成为ARM资源，可以使用新的客户端.CertificateOperations进行创建、更新和管理。

4.1.0 (2017-07-24)

• 新增了检查批处理账户名称可用性和有效性的操作。

4.0.0 (2017-05-10)

• 新增了列出Microsoft.Batch提供者可用的操作的命令，包括新的Operation和OperationDisplay模型。
• 将AddApplicationParameters重命名为ApplicationCreateParameters。
• 将UpdateApplicationParameters重命名为ApplicationUpdateParameters。
• 从BatchAccount对象中移除了core_quota属性，现在由单独的dedicated_core_quota和low_priority_core_quota替代。
• BatchAccountKeys对象现在具有额外的account_name属性。

3.0.1 (2017-04-19)

• 此轮包现在使用azure wheel扩展构建。

3.0.0 (2017-03-07)

• 更新了BatchAccount模型 - 支持在用户的订阅中进行池分配。
• 更新了BatchAccount模型 - 支持引用Azure密钥保管库以用于以UserSubscription池分配模式创建的账户。
• 更新了BatchAccount模型 - 属性现在是只读的。
• 更新了ApplicationPackage模型 - 属性现在是只读的。
• 更新了BatchAccountKeys模型 - 属性现在是只读的。
• 更新了BatchLocationQuota模型 - 属性现在是只读的。

2.0.0 (2016-10-04)

• 将AccountResource重命名为BatchAccount。
• 将AccountOperations重命名为BatchAccountOperations。同时，IBatchManagementClient.Account属性也重命名为IBatchManagementClient.BatchAccount。
• 将Application和ApplicationPackage操作拆分为两个单独的操作组。
• 更新了Application和ApplicationPackage方法，以使用标准的Create、Delete、Update语法。例如，创建Application是通过ApplicationOperations.Create完成的。
• 将SubscriptionOperations重命名为LocationOperations，并将SubscriptionOperations.GetSubscriptionQuotas更改为LocationOperations.GetQuotas。
• 此版本针对REST API版本2015-12-01。

1.0.0 (2016-08-09)

• 初始发布