Every API here is available over the APIs.io API and to AI agents over MCP.
{
"swagger": "2.0",
"info": {
"title": "BatchManagementClient",
"version": "2025-06-01",
"description": "The Batch Management Client.",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"host": "management.azure.com",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"tags": [
{
"name": "Operations"
},
{
"name": "BatchAccount"
},
{
"name": "DetectorResponses"
},
{
"name": "ApplicationPackage"
},
{
"name": "Application"
},
{
"name": "PrivateLinkResource"
},
{
"name": "PrivateEndpointConnection"
},
{
"name": "Pool"
},
{
"name": "NetworkSecurityPerimeter"
},
{
"name": "Location"
}
],
"paths": {
"/providers/Microsoft.Batch/operations": {
"get": {
"operationId": "Operations_List",
"tags": [
"Operations"
],
"description": "Lists available operations for the Microsoft.Batch provider",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"OperationsList": {
"$ref": "./examples/OperationsList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts": {
"get": {
"operationId": "BatchAccount_List",
"tags": [
"BatchAccount"
],
"description": "Gets information about the Batch accounts associated with the subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BatchAccountListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"BatchAccountList": {
"$ref": "./examples/BatchAccountList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability": {
"post": {
"operationId": "Location_CheckNameAvailability",
"tags": [
"Location"
],
"description": "Checks whether the Batch account name is available in the specified region.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "locationName",
"in": "path",
"description": "The desired region for the name check.",
"required": true,
"type": "string"
},
{
"name": "parameters",
"in": "body",
"description": "Properties needed to check the availability of a name.",
"required": true,
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityParameters"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"LocationCheckNameAvailability_AlreadyExists": {
"$ref": "./examples/LocationCheckNameAvailability_AlreadyExists.json"
},
"LocationCheckNameAvailability_Available": {
"$ref": "./examples/LocationCheckNameAvailability_Available.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas": {
"get": {
"operationId": "Location_GetQuotas",
"tags": [
"Location"
],
"description": "Gets the Batch service quotas for the specified subscription at the given location.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "locationName",
"in": "path",
"description": "The region for which to retrieve Batch service quotas.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BatchLocationQuota"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"LocationGetQuotas": {
"$ref": "./examples/LocationGetQuotas.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/virtualMachineSkus": {
"get": {
"operationId": "Location_ListSupportedVirtualMachineSkus",
"tags": [
"Location"
],
"description": "Gets the list of Batch supported Virtual Machine VM sizes available at the given location.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "locationName",
"in": "path",
"description": "The region for which to retrieve Batch service supported SKUs.",
"required": true,
"type": "string"
},
{
"name": "maxresults",
"in": "query",
"description": "The maximum number of items to return in the response.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$filter",
"in": "query",
"description": "OData filter expression. Valid properties for filtering are \"familyName\".",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/SupportedSkusResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"LocationListVirtualMachineSkus": {
"$ref": "./examples/LocationListVirtualMachineSkus.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts": {
"get": {
"operationId": "BatchAccount_ListByResourceGroup",
"tags": [
"BatchAccount"
],
"description": "Gets information about the Batch accounts associated with the specified resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BatchAccountListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"BatchAccountListByResourceGroup": {
"$ref": "./examples/BatchAccountListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}": {
"get": {
"operationId": "BatchAccount_Get",
"tags": [
"BatchAccount"
],
"description": "Gets information about the specified Batch account.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "accountName",
"in": "path",
"description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BatchAccount"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"BatchAccountGet": {
"$ref": "./examples/BatchAccountGet.json"
},
"PrivateBatchAccountGet": {
"$ref": "./examples/PrivateBatchAccountGet.json"
}
}
},
"put": {
"operationId": "BatchAccount_Create",
"tags": [
"BatchAccount"
],
"description": "Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "accountName",
"in": "path",
"description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "parameters",
"in": "body",
"description": "Additional parameters for account creation.",
"required": true,
"schema": {
"$ref": "#/definitions/BatchAccountCreateParameters"
}
}
],
"responses": {
"200": {
"description": "Resource 'BatchAccount' update operation succeeded",
"schema": {
"$ref": "#/definitions/BatchAccount"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"BatchAccountCreate_BYOS": {
"$ref": "./examples/BatchAccountCreate_BYOS.json"
},
"BatchAccountCreate_Default": {
"$ref": "./examples/BatchAccountCreate_Default.json"
},
"BatchAccountCreate_SystemAssignedIdentity": {
"$ref": "./examples/BatchAccountCreate_SystemAssignedIdentity.json"
},
"BatchAccountCreate_UserAssignedIdentity": {
"$ref": "./examples/BatchAccountCreate_UserAssignedIdentity.json"
},
"PrivateBatchAccountCreate": {
"$ref": "./examples/PrivateBatchAccountCreate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/BatchAccount"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "BatchAccount_Update",
"tags": [
"BatchAccount"
],
"description": "Updates the properties of an existing Batch account.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "accountName",
"in": "path",
"description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "parameters",
"in": "body",
"description": "Additional parameters for account update.",
"required": true,
"schema": {
"$ref": "#/definitions/BatchAccountUpdateParameters"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BatchAccount"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"BatchAccountUpdate": {
"$ref": "./examples/BatchAccountUpdate.json"
}
}
},
"delete": {
"operationId": "BatchAccount_Delete",
"tags": [
"BatchAccount"
],
"description": "Deletes the specified Batch account.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "accountName",
"in": "path",
"description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"BatchAccountDelete": {
"$ref": "./examples/BatchAccountDelete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications": {
"get": {
"operationId": "Application_List",
"tags": [
"Application"
],
"description": "Lists all of the applications in the specified account.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "accountName",
"in": "path",
"description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "maxresults",
"in": "query",
"description": "The maximum number of items to return in the response.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ListApplicationsResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"ApplicationList": {
"$ref": "./examples/ApplicationList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}": {
"get": {
"operationId": "Application_Get",
"tags": [
"Application"
],
"description": "Gets information about the specified application.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "accountName",
"in": "path",
"description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "applicationName",
"in": "path",
"description": "The name of the application. This must be unique within the account.",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9_-]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Application"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"ApplicationGet": {
"$ref": "./examples/ApplicationGet.json"
}
}
},
"put": {
"operationId": "Application_Create",
"tags": [
"Application"
],
"description": "Adds an application to the specified Batch account.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "accountName",
"in": "path",
"description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "applicationName",
"in": "path",
"description": "The name of the application. This must be unique within the account.",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"name": "parameters",
"in": "body",
"description": "The parameters for the request.",
"required": false,
"schema": {
"$ref": "#/definitions/Application"
}
}
],
"responses": {
"200": {
"description": "Resource 'Application' update operation succeeded",
"schema": {
"$ref": "#/definitions/Application"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"ApplicationCreate": {
"$ref": "./examples/ApplicationCreate.json"
}
}
},
"patch": {
"operationId": "Application_Update",
"tags": [
"Application"
],
"description": "Updates settings for the specified application.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "accountName",
"in": "path",
"description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "applicationName",
"in": "path",
"description": "The name of the application. This must be unique within the account.",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9_-]+$"
},
{
"name": "parameters",
"in": "body",
"description": "The parameters for the request.",
"required": true,
"schema": {
"$ref": "#/definitions/Application"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Application"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"ApplicationUpdate": {
"$ref": "./examples/ApplicationUpdate.json"
}
}
},
"delete": {
"operationId": "Application_Delete",
"tags": [
"Application"
],
"description": "Deletes an application.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "accountName",
"in": "path",
"description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "applicationName",
"in": "path",
"description": "The name of the application. This must be unique within the account.",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9_-]+$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definit
# --- truncated at 32 KB (287 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure-batch/refs/heads/main/openapi/_original/microsoft-azure-batch-management-openapi.json