{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-batch-batchmanagement","description":"BatchManagement","version":"2019-08-01","base_url":"https://management.azure.com","endpoints":35,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api BatchManagement\n@base https://management.azure.com\n@version 2019-08-01\n@auth OAuth2\n@common_fields {api-version: any # The API version to be used with the HTTP request., subscriptionId: any # The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)}\n@endpoints 35\n@hint download_for_search\n@toc subscriptions(34), providers(1)\n\n@group subscriptions\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}\n@desc 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.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # 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/., parameters: any # Additional parameters for account creation.}\n@returns(200) The operation was successful. The response contains the Batch account entity.\n@returns(202) The operation will be completed asynchronously.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}\n@desc Updates the properties of an existing Batch account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., parameters: any # Additional parameters for account update.}\n@returns(200) The operation was successful. The response contains the Batch account entity.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}\n@desc Deletes the specified Batch account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account.}\n@returns(200) The operation was successful.\n@returns(202) The operation will be completed asynchronously.\n@returns(204) NoContent -- account does not exist in the subscription.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}\n@desc Gets information about the specified Batch account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account.}\n@returns(200) The operation was successful. The response contains the Batch account entity.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts\n@desc Gets information about the Batch accounts associated with the subscription.\n@returns(200) The operation was successful. The response contains a list of Batch account entities associated with the subscription.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts\n@desc Gets information about the Batch accounts associated with the specified resource group.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account.}\n@returns(200) The operation was successful. The response contains a list of Batch account entities associated with the resource group.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys\n@desc Synchronizes access keys for the auto-storage account configured for the specified Batch account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account.}\n@returns(204) The operation was successful.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys\n@desc Regenerates the specified account key for the Batch account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., parameters: any # The type of key to regenerate.}\n@returns(200) The operation was successful. The response contains the Batch account keys.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys\n@desc Gets the account keys for the specified Batch account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account.}\n@returns(200) The operation was successful. The response contains the keys of the Batch account.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}/activate\n@desc 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\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., applicationName: any # The name of the application. This must be unique within the account., versionName: any # The version of the application., parameters: any # The parameters for the request.}\n@returns(200) The operation was successful. The response contains the application package entity.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}\n@desc Adds an application to the specified Batch account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., applicationName: any # The name of the application. This must be unique within the account.}\n@optional {parameters: any # The parameters for the request.}\n@returns(200) The operation was successful. The response contains the application entity.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}\n@desc Deletes an application.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., applicationName: any # The name of the application. This must be unique within the account.}\n@returns(200) The operation was successful.\n@returns(204) The operation was successful.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}\n@desc Gets information about the specified application.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., applicationName: any # The name of the application. This must be unique within the account.}\n@returns(200) The operation was successful. The response contains the application entity.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}\n@desc Updates settings for the specified application.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., applicationName: any # The name of the application. This must be unique within the account., parameters: any # The parameters for the request.}\n@returns(200) The operation was successful. The response contains the application entity.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}\n@desc 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.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., applicationName: any # The name of the application. This must be unique within the account., versionName: any # The version of the application.}\n@optional {parameters: any # The parameters for the request.}\n@returns(200) The operation was successful. The response contains the application package entity.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}\n@desc Deletes an application package record and its associated binary file.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., applicationName: any # The name of the application. This must be unique within the account., versionName: any # The version of the application.}\n@returns(200) The operation was successful.\n@returns(204) The operation was successful.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}\n@desc Gets information about the specified application package.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., applicationName: any # The name of the application. This must be unique within the account., versionName: any # The version of the application.}\n@returns(200) The operation was successful. The response contains the application package entity.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications\n@desc Lists all of the applications in the specified account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account.}\n@optional {maxresults: any # The maximum number of items to return in the response.}\n@returns(200) The operation was successful. The response contains a list of the application entities associated with the specified account.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions\n@desc Lists all of the application packages in the specified application.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., applicationName: any # The name of the application. This must be unique within the account.}\n@optional {maxresults: any # The maximum number of items to return in the response.}\n@returns(200) The operation was successful. The response contains a list of the application package entities associated with the specified application.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas\n@desc Gets the Batch service quotas for the specified subscription at the given location.\n@required {locationName: any # The region for which to retrieve Batch service quotas.}\n@returns(200) The operation was successful. The response contains the Batch service quotas for the subscription in the specified location.\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/Microsoft.Batch/operations\n@desc Lists available operations for the Microsoft.Batch provider\n@returns(200) The operation was successful. The response contains the list of available operations.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability\n@desc Checks whether the Batch account name is available in the specified region.\n@required {locationName: any # The desired region for the name check., parameters: any # Properties needed to check the availability of a name.}\n@returns(200) Success. Returns details about whether a Batch account name is available.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates\n@desc Lists all of the certificates in the specified account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account.}\n@optional {maxresults: any # The maximum number of items to return in the response., $select: any # Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection., $filter: any # OData filter expression. Valid properties for filtering are \"properties/provisioningState\", \"properties/provisioningStateTransitionTime\", \"name\".}\n@returns(200) The operation was successful. The response contains a list of certificates associated with the account.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}\n@desc Creates a new certificate inside the specified account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., certificateName: any # The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5., parameters: any # Additional parameters for certificate creation.}\n@optional {If-Match: any # The entity state (ETag) version of the certificate to update. A value of \"*\" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied., If-None-Match: any # Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored.}\n@returns(200) The operation was successful. The response contains the certificate entity.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}\n@desc Updates the properties of an existing certificate.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., certificateName: any # The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5., parameters: any # Certificate entity to update.}\n@optional {If-Match: any # The entity state (ETag) version of the certificate to update. This value can be omitted or set to \"*\" to apply the operation unconditionally.}\n@returns(200) The operation was successful. The response contains the certificate entity.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}\n@desc Deletes the specified certificate.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., certificateName: any # The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.}\n@returns(200) The operation was successful.\n@returns(202) The operation will be completed asynchronously.\n@returns(204) The operation was successful.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}\n@desc Gets information about the specified certificate.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., certificateName: any # The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.}\n@returns(200) The operation was successful. The response contains the certificate entity.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}/cancelDelete\n@desc Cancels a failed deletion of a certificate from the specified account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., certificateName: any # The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.}\n@returns(200) The operation was successful. The response contains the certificate entity.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools\n@desc Lists all of the pools in the specified account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account.}\n@optional {maxresults: any # The maximum number of items to return in the response., $select: any # Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection., $filter: any # OData filter expression. Valid properties for filtering are:   name  properties/allocationState  properties/allocationStateTransitionTime  properties/creationTime  properties/provisioningState  properties/provisioningStateTransitionTime  properties/lastModified  properties/vmSize  properties/interNodeCommunication  properties/scaleSettings/autoScale  properties/scaleSettings/fixedScale}\n@returns(200) The operation was successful. The response contains a list of certificates associated with the account.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}\n@desc Creates a new pool inside the specified account.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., poolName: any # The pool name. This must be unique within the account., parameters: any # Additional parameters for pool creation.}\n@optional {If-Match: any # The entity state (ETag) version of the pool to update. A value of \"*\" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied., If-None-Match: any # Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.}\n@returns(200) The operation was successful. The response contains the pool entity.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}\n@desc Updates the properties of an existing pool.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., poolName: any # The pool name. This must be unique within the account., parameters: any # Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.}\n@optional {If-Match: any # The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally.}\n@returns(200) The operation was successful. The response contains the pool entity.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}\n@desc Deletes the specified pool.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., poolName: any # The pool name. This must be unique within the account.}\n@returns(200) The operation was successful.\n@returns(202) The operation will be completed asynchronously.\n@returns(204) The operation was successful.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}\n@desc Gets information about the specified pool.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., poolName: any # The pool name. This must be unique within the account.}\n@returns(200) The operation was successful. The response contains the pool entity.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale\n@desc Disables automatic scaling for a pool.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., poolName: any # The pool name. This must be unique within the account.}\n@returns(200) The operation was successful. The response contains the pool entity.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize\n@desc Stops an ongoing resize operation on the pool.\n@required {resourceGroupName: any # The name of the resource group that contains the Batch account., accountName: any # The name of the Batch account., poolName: any # The pool name. This must be unique within the account.}\n@returns(200) The operation was successful. The response contains the pool entity.\n\n@endgroup\n\n@end\n"}