Microsoft Azure

Azure Batch: Batch Management

The Batch Management Client.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Batch Management Client.

Endpoints 46

BatchAccount

  • GETBatchAccount_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName?api-version=stringGets information about the specified Batch account.
  • PUTBatchAccount_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName?api-version=stringCreates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update…
  • DELETEBatchAccount_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName?api-version=stringDeletes the specified Batch account.
  • PATCHBatchAccount_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName?api-version=stringUpdates the properties of an existing Batch account.
  • GETBatchAccount_List/subscriptions/:subscriptionId/providers/Microsoft.Batch/batchAccounts?api-version=stringGets information about the Batch accounts associated with the subscription.
  • GETBatchAccount_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts?api-version=stringGets information about the Batch accounts associated with the specified resource group.
  • POSTBatchAccount_SynchronizeAutoStorageKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/syncAutoStorageKeys?api-version=stringSynchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
  • POSTRegenerates the specified account key for the Batch account./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/regenerateKeys?api-version=stringThis operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its…
  • POSTGets the account keys for the specified Batch account./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/listKeys?api-version=stringThis operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its…
  • GETBatchAccount_ListOutboundNetworkDependenciesEndpoints/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/outboundNetworkDependenciesEndpoints?api-version=stringLists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of…

ApplicationPackage

  • POSTApplicationPackage_Activate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName/versions/:versionName/activate?api-version=stringActivates the specified application package. This should be done after the ApplicationPackage was created and uploaded. This needs to be done before an…
  • GETApplicationPackage_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName/versions/:versionName?api-version=stringGets information about the specified application package.
  • PUTApplicationPackage_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName/versions/:versionName?api-version=stringCreates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the ApplicationPackage…
  • DELETEApplicationPackage_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName/versions/:versionName?api-version=stringDeletes an application package record and its associated binary file.
  • GETApplicationPackage_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName/versions?maxresults=0&api-version=stringLists all of the application packages in the specified application.

Application

  • GETApplication_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName?api-version=stringGets information about the specified application.
  • PUTApplication_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName?api-version=stringAdds an application to the specified Batch account.
  • DELETEApplication_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName?api-version=stringDeletes an application.
  • PATCHApplication_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName?api-version=stringUpdates settings for the specified application.
  • GETApplication_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications?maxresults=0&api-version=stringLists all of the applications in the specified account.

Location

  • GETLocation_GetQuotas/subscriptions/:subscriptionId/providers/Microsoft.Batch/locations/:locationName/quotas?api-version=stringGets the Batch service quotas for the specified subscription at the given location.
  • GETLocation_ListSupportedVirtualMachineSkus/subscriptions/:subscriptionId/providers/Microsoft.Batch/locations/:locationName/virtualMachineSkus?maxresults=0&$filter=string&api-version=stringGets the list of Batch supported Virtual Machine VM sizes available at the given location.
  • GETLocation_ListSupportedCloudServiceSkus/subscriptions/:subscriptionId/providers/Microsoft.Batch/locations/:locationName/cloudServiceSkus?maxresults=0&$filter=string&api-version=stringGets the list of Batch supported Cloud Service VM sizes available at the given location.

Operations

  • GETOperations_List/providers/Microsoft.Batch/operations?api-version=stringLists available operations for the Microsoft.Batch provider

Certificate

  • GETLists all of the certificates in the specified account./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/certificates?maxresults=0&$select=string&$filter=string&api-version=stringDeprecated. Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
  • GETGets information about the specified certificate./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/certificates/:certificateName?api-version=stringDeprecated. Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
  • PUTCreates a new certificate inside the specified account./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/certificates/:certificateName?api-version=stringDeprecated. Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
  • DELETEDeletes the specified certificate./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/certificates/:certificateName?api-version=stringDeprecated. Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
  • PATCHUpdates the properties of an existing certificate./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/certificates/:certificateName?api-version=stringDeprecated. Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
  • POSTCancels a failed deletion of a certificate from the specified account./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/certificates/:certificateName/cancelDelete?api-version=stringDeprecated. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you…

PrivateLinkResource

  • GETPrivateLinkResource_ListByBatchAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateLinkResources?api-version=string&maxresults=0Lists all of the private link resources in the specified account.
  • GETPrivateLinkResource_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateLinkResources/:privateLinkResourceName?api-version=stringGets information about the specified private link resource.

PrivateEndpointConnection

  • GETPrivateEndpointConnection_ListByBatchAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateEndpointConnections?api-version=string&maxresults=0Lists all of the private endpoint connections in the specified account.
  • GETPrivateEndpointConnection_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringGets information about the specified private endpoint connection.
  • DELETEPrivateEndpointConnection_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringDeletes the specified private endpoint connection.
  • PATCHPrivateEndpointConnection_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringUpdates the properties of an existing private endpoint connection.

Pool

  • GETPool_ListByBatchAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools?maxresults=0&$select=string&$filter=string&api-version=stringLists all of the pools in the specified account.
  • GETPool_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolName?api-version=stringGets information about the specified pool.
  • PUTPool_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolName?api-version=stringCreates a new pool inside the specified account.
  • DELETEPool_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolName?api-version=stringDeletes the specified pool.
  • PATCHPool_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolName?api-version=stringUpdates the properties of an existing pool.
  • POSTPool_DisableAutoScale/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolName/disableAutoScale?api-version=stringDisables automatic scaling for a pool.
  • POSTStops an ongoing resize operation on the pool./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolName/stopResize?api-version=stringThis does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its…
  • POSTLocation_CheckNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.Batch/locations/:locationName/checkNameAvailability?api-version=stringChecks whether the Batch account name is available in the specified region.
  • GETBatchAccount_ListDetectors/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/detectors?api-version=stringGets information about the detectors available for a given Batch account.
  • GETBatchAccount_GetDetector/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/detectors/:detectorId?api-version=stringGets information about the given detector for a given Batch account.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
46 operations on 30 pathsGET 22POST 8DELETE 6PUT 5PATCH 5
6 marked deprecated
Main resources
BatchAccount 10Pool 7Certificate 6Application 5ApplicationPackage 5PrivateEndpointConnection 4Location 3PrivateLinkResource 2Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2024-02-01

How to test the Azure Batch: Batch Management in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Batch: Batch Management collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “BatchAccount_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Batch: Batch Management?

The Batch Management Client. It is listed under Developer tools and has 46 endpoints.

Who publishes the Azure Batch: Batch Management?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Batch: Batch Management?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Batch: Batch Management?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Batch: Batch Management have?

46 operations on 30 paths (22 GET, 8 POST, 6 DELETE, 5 PUT, 5 PATCH). The largest groups are BatchAccount, Pool, Certificate, Application.

Is forking the Azure Batch: Batch Management free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.