Microsoft Azure Batch Management is a cloud-based service that allows users to efficiently and effectively manage and execute large-scale parallel and high-performance computational tasks. It provides the capability to dynamically provision compute resources on demand, scale resources up or down based on workload, and schedule and distribute tasks across multiple virtual machines.
swagger: '2.0'
info:
title: Microsoft Azure BatchManagement
version: '2021-01-01'
x-ms-code-generation-settings:
name: BatchManagementClient
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow
scopes:
user_impersonation: impersonate your user account
paths:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}:
put:
tags:
- BatchAccount
operationId: microsoftAzureBatchaccountCreate
x-ms-examples:
BatchAccountCreate_Default:
$ref: ./examples/BatchAccountCreate_Default.json
BatchAccountCreate_BYOS:
$ref: ./examples/BatchAccountCreate_BYOS.json
PrivateBatchAccountCreate:
$ref: ./examples/PrivateBatchAccountCreate.json
BatchAccountCreate_SystemAssignedIdentity:
$ref: ./examples/BatchAccountCreate_SystemAssignedIdentity.json
BatchAccountCreate_UserAssignedIdentity:
$ref: ./examples/BatchAccountCreate_UserAssignedIdentity.json
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: '#/parameters/ResourceGroupNameParameter'
- name: accountName
in: path
required: true
type: string
pattern: ^[a-z0-9]+$
minLength: 3
maxLength: 24
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/.
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/BatchAccountCreateParameters'
description: Additional parameters for account creation.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the Batch
account entity.
schema:
$ref: '#/definitions/BatchAccount'
'202':
description: The operation will be completed asynchronously.
headers:
Location:
description: >-
The URL of the resource used to check the status of the
asynchronous operation.
type: string
Retry-After:
description: >-
Suggested delay to check the status of the asynchronous
operation. The value is an integer that specifies the delay in
seconds.
type: integer
format: int32
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname
patch:
tags:
- BatchAccount
operationId: microsoftAzureBatchaccountUpdate
x-ms-examples:
BatchAccountUpdate:
$ref: ./examples/BatchAccountUpdate.json
description: Updates the properties of an existing Batch account.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/BatchAccountUpdateParameters'
description: Additional parameters for account update.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the Batch
account entity.
schema:
$ref: '#/definitions/BatchAccount'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname
delete:
tags:
- BatchAccount
operationId: microsoftAzureBatchaccountDelete
x-ms-examples:
BatchAccountDelete:
$ref: ./examples/BatchAccountDelete.json
description: Deletes the specified Batch account.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: The operation was successful.
'202':
description: The operation will be completed asynchronously.
headers:
Location:
description: >-
The URL of the resource used to check the status of the
asynchronous operation.
type: string
Retry-After:
description: >-
Suggested delay to check the status of the asynchronous
operation. The value is an integer that specifies the delay in
seconds.
type: integer
format: int32
'204':
description: NoContent -- account does not exist in the subscription.
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname
get:
tags:
- BatchAccount
operationId: microsoftAzureBatchaccountGet
x-ms-examples:
BatchAccountGet:
$ref: ./examples/BatchAccountGet.json
PrivateBatchAccountGet:
$ref: ./examples/PrivateBatchAccountGet.json
description: Gets information about the specified Batch account.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the Batch
account entity.
schema:
$ref: '#/definitions/BatchAccount'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname
/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts:
get:
tags:
- BatchAccount
operationId: microsoftAzureBatchaccountList
x-ms-examples:
BatchAccountList:
$ref: ./examples/BatchAccountList.json
description: >-
Gets information about the Batch accounts associated with the
subscription.
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains a list of Batch
account entities associated with the subscription.
schema:
$ref: '#/definitions/BatchAccountListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Batch Batchaccounts
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts:
get:
tags:
- BatchAccount
operationId: microsoftAzureBatchaccountListbyresourcegroup
x-ms-examples:
BatchAccountListByResourceGroup:
$ref: ./examples/BatchAccountListByResourceGroup.json
description: >-
Gets information about the Batch accounts associated with the specified
resource group.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains a list of Batch
account entities associated with the resource group.
schema:
$ref: '#/definitions/BatchAccountListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys
: post:
tags:
- BatchAccount
operationId: microsoftAzureBatchaccountSynchronizeautostoragekeys
x-ms-examples:
BatchAccountSynchronizeAutoStorageKeys:
$ref: ./examples/BatchAccountSynchronizeAutoStorageKeys.json
description: >-
Synchronizes access keys for the auto-storage account configured for the
specified Batch account.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'204':
description: The operation was successful.
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Syncautostoragekeys
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys
: post:
tags:
- BatchAccount
operationId: microsoftAzureBatchaccountRegeneratekey
x-ms-examples:
BatchAccountRegenerateKey:
$ref: ./examples/BatchAccountRegenerateKey.json
description: Regenerates the specified account key for the Batch account.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/BatchAccountRegenerateKeyParameters'
description: The type of key to regenerate.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the Batch
account keys.
schema:
$ref: '#/definitions/BatchAccountKeys'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Regeneratekeys
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys
: post:
tags:
- BatchAccount
operationId: microsoftAzureBatchaccountGetkeys
x-ms-examples:
BatchAccountGetKeys:
$ref: ./examples/BatchAccountGetKeys.json
summary: 'Microsoft Azure Gets The Account Keys For The Specified Batch Account'
description: >-
This operation applies only to Batch accounts created with a
poolAllocationMode of 'BatchService'. If the Batch account was created
with a poolAllocationMode of 'UserSubscription', clients cannot use
access to keys to authenticate, and must use Azure Active Directory
instead. In this case, getting the keys will fail.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the keys of the
Batch account.
schema:
$ref: '#/definitions/BatchAccountKeys'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}/activate
: post:
tags:
- ApplicationPackage
operationId: microsoftAzureApplicationpackageActivate
x-ms-examples:
ApplicationPackageActivate:
$ref: ./examples/ApplicationPackageActivate.json
description: >-
Activates the specified application package. This should be done after
the `ApplicationPackage` was created and uploaded. This needs to be done
before an `ApplicationPackage` can be used on Pools or Tasks.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApplicationNameParameter'
- $ref: '#/parameters/VersionNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/ActivateApplicationPackageParameters'
description: The parameters for the request.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the application
package entity.
schema:
$ref: '#/definitions/ApplicationPackage'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname Versions Versionname Activate
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
: put:
tags:
- Application
operationId: microsoftAzureApplicationCreate
x-ms-examples:
ApplicationCreate:
$ref: ./examples/ApplicationCreate.json
description: Adds an application to the specified Batch account.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApplicationNameParameter'
- name: parameters
in: body
required: false
schema:
$ref: '#/definitions/Application'
description: The parameters for the request.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the application
entity.
schema:
$ref: '#/definitions/Application'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
delete:
tags:
- Application
operationId: microsoftAzureApplicationDelete
x-ms-examples:
ApplicationDelete:
$ref: ./examples/ApplicationDelete.json
description: Deletes an application.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApplicationNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: The operation was successful.
'204':
description: The operation was successful.
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
get:
tags:
- Application
operationId: microsoftAzureApplicationGet
x-ms-examples:
ApplicationGet:
$ref: ./examples/ApplicationGet.json
description: Gets information about the specified application.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApplicationNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the application
entity.
schema:
$ref: '#/definitions/Application'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
patch:
tags:
- Application
operationId: microsoftAzureApplicationUpdate
x-ms-examples:
ApplicationUpdate:
$ref: ./examples/ApplicationUpdate.json
description: Updates settings for the specified application.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApplicationNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/Application'
description: The parameters for the request.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the application
entity.
schema:
$ref: '#/definitions/Application'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}
: put:
tags:
- ApplicationPackage
operationId: microsoftAzureApplicationpackageCreate
x-ms-examples:
ApplicationPackageCreate:
$ref: ./examples/ApplicationPackageCreate.json
description: >-
Creates an application package record. The record contains the SAS where
the package should be uploaded to. Once it is uploaded the
`ApplicationPackage` needs to be activated using
`ApplicationPackageActive` before it can be used.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApplicationNameParameter'
- $ref: '#/parameters/VersionNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- name: parameters
in: body
required: false
schema:
$ref: '#/definitions/ApplicationPackage'
description: The parameters for the request.
responses:
'200':
description: >-
The operation was successful. The response contains the application
package entity.
schema:
$ref: '#/definitions/ApplicationPackage'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname Versions Versionname
delete:
tags:
- ApplicationPackage
operationId: microsoftAzureApplicationpackageDelete
x-ms-examples:
ApplicationPackageDelete:
$ref: ./examples/ApplicationPackageDelete.json
description: Deletes an application package record and its associated binary file.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApplicationNameParameter'
- $ref: '#/parameters/VersionNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: The operation was successful.
'204':
description: The operation was successful.
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname Versions Versionname
get:
tags:
- ApplicationPackage
operationId: microsoftAzureApplicationpackageGet
x-ms-examples:
ApplicationPackageGet:
$ref: ./examples/ApplicationPackageGet.json
description: Gets information about the specified application package.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApplicationNameParameter'
- $ref: '#/parameters/VersionNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the application
package entity.
schema:
$ref: '#/definitions/ApplicationPackage'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname Versions Versionname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications
: get:
tags:
- Application
operationId: microsoftAzureApplicationList
x-ms-examples:
ApplicationList:
$ref: ./examples/ApplicationList.json
description: Lists all of the applications in the specified account.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- name: maxresults
in: query
required: false
type: integer
format: int32
description: The maximum number of items to return in the response.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains a list of the
application entities associated with the specified account.
schema:
$ref: '#/definitions/ListApplicationsResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions
: get:
tags:
- ApplicationPackage
operationId: microsoftAzureApplicationpackageList
x-ms-examples:
ApplicationList:
$ref: ./examples/ApplicationPackageList.json
description: Lists all of the application packages in the specified application.
parameters:
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/AccountNameParameter'
- $ref: '#/parameters/ApplicationNameParameter'
- name: maxresults
in: query
required: false
type: integer
format: int32
description: The maximum number of items to return in the response.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains a list of the
application package entities associated with the specified
application.
schema:
$ref: '#/definitions/ListApplicationPackagesResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname Versions
/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas:
get:
tags:
- Location
operationId: microsoftAzureLocationGetquotas
x-ms-examples:
LocationGetQuotas:
$ref: ./examples/LocationGetQuotas.json
description: >-
Gets the Batch service quotas for the specified subscription at the
given location.
parameters:
- name: locationName
in: path
required: true
type: string
description: The region for which to retrieve Batch service quotas.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the Batch
service quotas for the subscription in the specified location.
schema:
$ref: '#/definitions/BatchLocationQuota'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Batch Locations Locationname Quotas
/providers/Microsoft.Batch/operations:
get:
tags:
- Operations
operationId: microsoftAzureOperationsList
description: Lists available operations for the Microsoft.Batch provider
parameters:
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: >-
The operation was successful. The response contains the list of
available operations.
schema:
$ref: '#/definitions/OperationListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Providers Microsoft Batch Operations
/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability:
post:
operationId: microsoftAzureLocationChecknameavailability
description: >-
Checks whether the Batch account name is available in the specified
region.
x-ms-examples:
LocationCheckNameAvailability_Available:
$ref: ./examples/LocationCheckNameAvailability_Available.json
LocationCheckNameAvailability_AlreadyExists:
$ref: ./examples/LocationCheckNameAvailability_AlreadyExists.json
parameters:
- name: locationName
in: path
required: true
type: string
description: The desired region for the name check.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/CheckNameAvailabilityParameters'
description: Properties needed to check the availability of a name.
responses:
'200':
description: >-
Success. Returns details about whether a Batch account name is
available.
schema:
$ref: '#/definitions/CheckNameAvailabilityResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Batch Locations Locationname Checknameavailability
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates
: get:
tags:
- Certificate
operationId: microsoftAzureCertificateListbybatchaccount
description: Lists all of the certificates in the specified account.
x-ms-examples:
ListCertificates:
$ref: ./examples/CertificateList.json
ListCertificates - Filter and Select:
$ref: ./examples/CertificateListWithFilter.json
parameters:
# --- truncated at 32 KB (182 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/batchmanagement-openapi-original.yml