Azure Batch: Openapi
The Batch Management Client.
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 42
Operations
- GETOperations_List
/providers/Microsoft.Batch/operationsLists available operations for the Microsoft.Batch provider
BatchAccount
- GETBatchAccount_List
/subscriptions/:subscriptionId/providers/Microsoft.Batch/batchAccountsGets information about the Batch accounts associated with the subscription. - GETBatchAccount_ListByResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccountsGets information about the Batch accounts associated with the specified resource group. - GETBatchAccount_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountNameGets information about the specified Batch account. - PUTBatchAccount_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountNameCreates 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/:accountNameDeletes the specified Batch account. - PATCHBatchAccount_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountNameUpdates the properties of an existing Batch account. - POSTGets the account keys for the specified Batch account.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/listKeysThis 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/outboundNetworkDependenciesEndpointsLists 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… - POSTRegenerates the specified account key for the Batch account.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/regenerateKeysThis operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its… - POSTBatchAccount_SynchronizeAutoStorageKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/syncAutoStorageKeysSynchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
DetectorResponses
- GETBatchAccount_ListDetectors
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/detectorsGets information about the detectors available for a given Batch account. - GETBatchAccount_GetDetector
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/detectors/:detectorIdGets information about the given detector for a given Batch account.
ApplicationPackage
- GETApplicationPackage_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName/versions?maxresults=0Lists all of the application packages in the specified application. - GETApplicationPackage_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName/versions/:versionNameGets information about the specified application package. - PUTApplicationPackage_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName/versions/:versionNameCreates 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/:versionNameDeletes an application package record and its associated binary file. - POSTApplicationPackage_Activate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationName/versions/:versionName/activateActivates the specified application package. This should be done after the ApplicationPackage was created and uploaded. This needs to be done before an…
Application
- GETApplication_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications?maxresults=0Lists all of the applications in the specified account. - GETApplication_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationNameGets information about the specified application. - PUTApplication_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationNameAdds an application to the specified Batch account. - DELETEApplication_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationNameDeletes an application. - PATCHApplication_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/applications/:applicationNameUpdates settings for the specified application.
PrivateLinkResource
- GETPrivateLinkResource_ListByBatchAccount
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateLinkResources?maxresults=0Lists all of the private link resources in the specified account. - GETPrivateLinkResource_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateLinkResources/:privateLinkResourceNameGets information about the specified private link resource.
PrivateEndpointConnection
- GETPrivateEndpointConnection_ListByBatchAccount
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateEndpointConnections?maxresults=0Lists all of the private endpoint connections in the specified account. - GETPrivateEndpointConnection_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateEndpointConnections/:privateEndpointConnectionNameGets information about the specified private endpoint connection. - DELETEPrivateEndpointConnection_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateEndpointConnections/:privateEndpointConnectionNameDeletes the specified private endpoint connection. - PATCHPrivateEndpointConnection_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/privateEndpointConnections/:privateEndpointConnectionNameUpdates 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=stringLists all of the pools in the specified account. - GETPool_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolNameGets information about the specified pool. - PUTPool_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolNameCreates a new pool inside the specified account. - DELETEPool_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolNameDeletes the specified pool. - PATCHPool_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolNameUpdates the properties of an existing pool. - POSTPool_DisableAutoScale
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolName/disableAutoScaleDisables automatic scaling for a pool. - POSTStops an ongoing resize operation on the pool.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/pools/:poolName/stopResizeThis 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…
NetworkSecurityPerimeter
- GETNetworkSecurityPerimeter_ListConfigurations
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/networkSecurityPerimeterConfigurationsLists all of the NSP configurations in the specified account. - GETNetworkSecurityPerimeter_GetConfiguration
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/networkSecurityPerimeterConfigurations/:networkSecurityPerimeterConfigurationNameGets information about the specified NSP configuration. - POSTNetworkSecurityPerimeter_ReconcileConfiguration
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Batch/batchAccounts/:accountName/networkSecurityPerimeterConfigurations/:networkSecurityPerimeterConfigurationName/reconcileReconciles the specified NSP configuration.
Location
- POSTLocation_CheckNameAvailability
/subscriptions/:subscriptionId/providers/Microsoft.Batch/locations/:locationName/checkNameAvailabilityChecks whether the Batch account name is available in the specified region. - GETLocation_GetQuotas
/subscriptions/:subscriptionId/providers/Microsoft.Batch/locations/:locationName/quotasGets 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=stringGets the list of Batch supported Virtual Machine VM sizes available at the given location.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 42 operations on 29 pathsGET 21POST 8DELETE 5PUT 4PATCH 4
- Main resources
- BatchAccount 10Pool 7Application 5ApplicationPackage 5PrivateEndpointConnection 4Location 3NetworkSecurityPerimeter 3DetectorResponses 2PrivateLinkResource 2Operations 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2025-06-01 - Links
- OpenAPI document
How to test the Azure Batch: Openapi in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Batch: Openapi collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.Batch/operations), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Batch: Openapi?
The Batch Management Client. It is listed under Developer tools and has 42 endpoints.
Who publishes the Azure Batch: Openapi?
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: Openapi?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Batch: Openapi?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Batch: Openapi have?
42 operations on 29 paths (21 GET, 8 POST, 5 DELETE, 4 PUT, 4 PATCH). The largest groups are BatchAccount, Pool, Application, ApplicationPackage.
Is forking the Azure Batch: Openapi free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.