Package: azure-mgmt-batch
Microsoft Azure SDK for PythonThis is the Microsoft Azure Batch Management Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see theazure sdk python release.DisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.7+ is required to use this package.Azure subscriptionInstall the packagepipinstallazure-mgmt-batch
pipinstallazure-identityAuthenticationBy default,Azure Active Directorytoken authentication depends on correct configure of following environment variables.AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor Azure client secret.In addition, Azure subscription ID can be configured via environment variableAZURE_SUBSCRIPTION_ID.With above configuration, client can be authenticated by following code:fromazure.identityimportDefaultAzureCredentialfromazure.mgmt.batchimportBatchManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=BatchManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search Batch Managementon docs.microsoft.comAzure Python Mgmt SDK Samples RepoTroubleshootingNext stepsProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History17.2.0 (2023-12-18)Features AddedModel OSDisk has a new parameter cachingModel OSDisk has a new parameter disk_size_gbModel OSDisk has a new parameter managed_diskModel OSDisk has a new parameter write_accelerator_enabledModel Pool has a new parameter resource_tagsModel VirtualMachineConfiguration has a new parameter security_profileModel VirtualMachineConfiguration has a new parameter service_artifact_reference17.1.0 (2023-07-21)Features AddedModel NetworkConfiguration has a new parameter enable_accelerated_networkingModel VMExtension has a new parameter enable_automatic_upgradeModel ContainerConfiguration allows two possible values:dockerCompatibleandcriCompatibleinstead of fixed valuedockerCompatible17.0.0 (2022-11-23)Features AddedModel NetworkConfiguration has a new parameter dynamic_vnet_assignment_scopeModel Pool has a new parameter current_node_communication_modeModel Pool has a new parameter target_node_communication_modeModel PrivateLinkServiceConnectionState has a new parameter actions_requiredBreaking ChangesModel CIFSMountConfiguration has a new required parameter user_nameModel CIFSMountConfiguration no longer has parameter usernameModel NetworkConfiguration no longer has parameter dynamic_v_net_assignment_scopeModel PrivateLinkServiceConnectionState no longer has parameter action_required16.2.0 (2022-06-06)FeaturesAdded operation PrivateEndpointConnectionOperations.begin_deleteModel BatchAccount has a new parameter network_profileModel BatchAccount has a new parameter node_management_endpointModel BatchAccountCreateParameters has a new parameter network_profileModel BatchAccountUpdateParameters has a new parameter network_profileModel BatchAccountUpdateParameters has a new parameter public_network_accessModel PrivateEndpointConnection has a new parameter group_ids16.1.0 (2022-02-24)FeaturesAdded operation BatchAccountOperations.get_detectorAdded operation BatchAccountOperations.list_detectorsModel NetworkConfiguration has a new parameter dynamic_v_net_assignment_scope16.0.0 (2021-07-30)FeaturesModel BatchAccount has a new parameter allowed_authentication_modesModel AutoStorageBaseProperties has a new parameter node_identity_referenceModel AutoStorageBaseProperties has a new parameter authentication_modeModel AzureBlobFileSystemConfiguration has a new parameter identity_referenceModel BatchAccountUpdateParameters has a new parameter allowed_authentication_modesModel ContainerRegistry has a new parameter identity_referenceModel Operation has a new parameter is_data_actionModel BatchAccountCreateParameters has a new parameter allowed_authentication_modesModel AutoStorageProperties has a new parameter node_identity_referenceModel AutoStorageProperties has a new parameter authentication_modeModel ResourceFile has a new parameter identity_referenceModel VirtualMachineConfiguration has a new parameter os_diskAdded operation BatchAccountOperations.list_outbound_network_dependencies_endpointsAdded operation LocationOperations.list_supported_cloud_service_skusAdded operation LocationOperations.list_supported_virtual_machine_skusBreaking changesRenameBatchManagementtoBatchManagementClient15.0.0 (2021-02-01)Fix changelog15.0.0b1 (2021-01-28)FeaturesAdded new extensions property to VirtualMachineConfiguration on pools to specify virtual machine extensions for nodesAdded the ability to specify availability zones using a new property node_placement_configuration on VirtualMachineConfigurationAdded a new identity property on Pool to specify a managed identityAdded a new user_assigned_identities on BatchAccountIdentity to specify a user managed identityAdded certificate operation method PoolOperations.createAdded certificate operation method CertificateOperations.createBreaking changesRemoved certificate operation method PoolOperations.begin_create. Certificate operations are not long running operations so this was incorrect.Removed certificate operation method CertificateOperations.begin_create. Certificate operations are not long running operations so this was incorrect.14.0.0 (2020-12-22)GA release14.0.0b1 (2020-10-23)This is beta preview version.This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).General breaking changesCredential system has been completly revamped:azure.common.credentialsormsrestazure.azure_active_directoryinstances are no longer supported, use theazure-identityclasses instead:https://pypi.org/project/azure-identity/credentialsparameter has been renamedcredentialTheconfigattribute no longer exists on a client, configuration should be passed as kwarg. Example:MyClient(credential, subscription_id, enable_logging=True). For a complete set of
supported options, see theparameters accept in init documentation of azure-coreYou can't import aversionmodule anymore, use__version__insteadOperations that used to return amsrest.polling.LROPollernow returns aazure.core.polling.LROPollerand are prefixed withbegin_.Exceptions tree have been simplified and most exceptions are nowazure.core.exceptions.HttpResponseError(CloudErrorhas been removed).Most of the operation kwarg have changed. Some of the most noticeable:rawhas been removed. Equivalent feature can be found usingcls, a callback that will give access to internal HTTP response for advanced userFor a complete set of
supported options, see theparameters accept in Request documentation of azure-coreGeneral new featuresType annotations support usingtyping. SDKs are mypy ready.This client has now stable and official support for async. Check theaionamespace of your package to find the async client.This client now support natively tracing library like OpenCensus or OpenTelemetry. See thistracing quickstartfor an overview.9.0.0 (2020-05-29)REST API versionThis version targets REST API version 2020-05-01.FeaturesAdded ability to access the Batch DataPlane API without needing a public DNS entry for the account via the newpublic_network_accessproperty onBatchAccount.Added newPrivateLinkResourceandPrivateEndpointConnectionresource types. These are both only used when thepublic_network_accessproperty onBatchAccountis set toDisabled.Whenpublic_network_accessis set toDisableda newPrivateLinkResourceis visible in that account, which can be used to connect to the account using an ARM Private Endpoint in your VNET.Added ability to encryptComputeNodedisk drives using the newdisk_encryption_configurationproperty ofVirtualMachineConfiguration.[Breaking]Theidproperty ofImageReferencecan now only refer to a Shared Image Gallery image.[Breaking]Pools can now be provisioned without a public IP using the newpublic_ip_configurationproperty ofNetworkConfiguration.Thepublic_ipsproperty ofNetworkConfigurationhas moved in toPublicIPAddressConfigurationas well. This property can only be specified ifIPAddressProvisioningTypeisUserManaged.Adds a new propertyidentityof typeBatchAccountIdentitytoBatchAccount. This can be used to configure how customer data is encrypted inside the Batch account.This new property is configurable at  the account level on create and update through a newidentityproperty onBatchAccountCreateParametersandBatchAccountUpdateParametersFixes[Breaking] Move tags from being an argument on create and update pool parameters to being a part ofBatchAccountCreateParametersandBatchAccountUpdateParametersto properly reflect the REST API8.0.1 (2020-05-26) [Deprecated]NoticesThis version targeted an invalid REST API. This version does not honor the associated REST API contract.BugfixesFix issues in PrivateEndpointConnection get and update methods due to mistakes in the Swagger specification causing validation to fail. It is advised to use version 9+ to make use of the features added in this version.8.0.0 (2020-04-10) [Deprecated]NoticesThis version targeted an invalid REST API. Currently the PrivateEndpoint get() and update() functions do not function correctly. It is advised to use version 9+ to make use of the features added in this version.REST API versionThis version targets REST API version 2020-03-01.FeaturesAdded ability to access the Batch DataPlane API without needing a public DNS entry for the account via the newpublic_network_accessproperty onBatchAccount.Added newPrivateLinkResourceandPrivateEndpointConnectionresource types. These are both only used when thepublic_network_accessproperty onBatchAccountis set toDisabled.Whenpublic_network_accessis set toDisableda newPrivateLinkResourceis visible in that account, which can be used to connect to the account using an ARM Private Endpoint in your VNET.Added ability to encryptComputeNodedisk drives using the newdisk_encryption_configurationproperty ofVirtualMachineConfiguration.[Breaking]Theidproperty ofImageReferencecan now only refer to a Shared Image Gallery image.[Breaking]Pools can now be provisioned without a public IP using the newpublic_ip_configurationproperty ofNetworkConfiguration.Thepublic_ipsproperty ofNetworkConfigurationhas moved in toPublicIPAddressConfigurationas well. This property can only be specified ifIPAddressProvisioningTypeisUserManaged.7.0.0 (2019-08-05)Added ability to specify a collection of public IPs onNetworkConfigurationvia the newpublic_ipsproperty. This
guarantees nodes in the Pool will have an IP from the list user
provided IPs.Added ability to mount remote file-systems on each node of a pool
via themount_configurationproperty onPool.Shared Image Gallery images can now be specified on theidproperty ofImageReferenceby referencing the image via its ARM
ID.[Breaking]When not specified, the default value forwait_for_successonStartTaskis nowTrue(wasFalse).[Breaking]When not specified, the default value forscopeonAutoUserSpecificationis now alwaysPool(wasTaskon
Windows nodes,Poolon Linux nodes).BreakingModel signatures are now using only keywords-arguments
syntax. Each positional argument must be rewritten as a keyword
argument.Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.6.0.0 (2019-01-14)[Breaking]ResourceFile improvementsAdded the ability specify an entire Azure Storage container
inResourceFile.A new propertyHttpUrlreplacesBlobSource. This can
be any HTTP URL. Previously, this had to be an Azure Blob
Storage URL.When constructing aResourceFileyou can now choose
from one of the following options:HttpUrl: Specify an HTTP URL pointing to a
specific file to download.StorageContainerUrl: Specify an Azure Storage
container URL. All blobs matching theBlobPrefixin the Storage container will be downloaded.AutoStorageContainerName: Specify the name of a
container in the Batch registered auto-storage
account. All blobs matching theBlobPrefixin
the Storage container will be downloaded.[Breaking]RemovedOSDiskproperty fromVirtualMachineConfiguration. This property is no longer
supported.[Breaking]Applicationno longer has aPackagesproperty, instead the packages can be retrieved via the newApplicationPackage.ListAPI.[Breaking]TargetOsVersionis nowOsVersion, andCurrentOsVersionis no longer supported onCloudServiceConfiguration.Added support on Windows pools for creating users with a specific
login mode (eitherBatchorInteractive) viaWindowsUserConfiguration.LoginMode.Added support forContainerConfigurationwhen creating a pool.5.0.1 (2018-05-25)BugfixesCompatibility of the sdist with wheel 0.31.0msrestazure dependency version range5.0.0 (2017-11-13)Batch Pools are now ARM resources that can be created, updated and
managed using the new client.PoolOperations.Batch Certificates are now ARM resources that can be created,
updated and managed using the new client.CertificateOperations.4.1.0 (2017-07-24)New operation to check the availability and validity of a Batch
account name.4.0.0 (2017-05-10)New operation to list the operations available for the
Microsoft.Batch provider, includes newOperationandOperationDisplaymodels.RenamedAddApplicationParameterstoApplicationCreateParameters.RenamedUpdateApplicationParameterstoApplicationUpdateParameters.Removedcore_quotaattribute fromBatchAccountobject, now
replaced by separatededicated_core_quotaandlow_priority_core_quota.BatchAccountKeysobject now has additionalaccount_nameattribute.3.0.1 (2017-04-19)This wheel package is now built with the azure wheel extension3.0.0 (2017-03-07)UpdatedBatchAccountmodel - support for pool allocation in the
user's subscription.UpdatedBatchAccountmodel - support for referencing an Azure
Key Vault for accounts created with a pool allocation mode of
UserSubscription.UpdatedBatchAccountmodel - properties are now read only.UpdatedApplicationPackagemodel - properties are now read only.UpdatedBatchAccountKeysmodel - properties are now read only.UpdatedBatchLocationQuotamodel - properties are now read only.2.0.0 (2016-10-04)RenamedAccountResourcetoBatchAccount.RenamedAccountOperationstoBatchAccountOperations. TheIBatchManagementClient.Accountproperty was also renamed toIBatchManagementClient.BatchAccount.SplitApplicationandApplicationPackageoperations up into
two separate operation groups.UpdatedApplicationandApplicationPackagemethods to use
the standardCreate,Delete,Updatesyntax. For example
creating anApplicationis done viaApplicationOperations.Create.RenamedSubscriptionOperationstoLocationOperationsand
changedSubscriptionOperations.GetSubscriptionQuotasto beLocationOperations.GetQuotas.This version targets REST API version 2015-12-01.1.0.0 (2016-08-09)Initial Release