{ "swagger": "2.0", "info": { "title": "BatchManagement", "version": "2015-12-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": "BatchAccount_Create", "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": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the new Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "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 represents the seconds.", "type": "integer", "format": "int32" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "patch": { "tags": [ "BatchAccount" ], "operationId": "BatchAccount_Update", "description": "Updates the properties of an existing Batch account.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the account." }, { "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" } } } }, "delete": { "tags": [ "BatchAccount" ], "operationId": "BatchAccount_Delete", "description": "Deletes the specified Batch account.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account to be deleted." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the account to be deleted." }, { "$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 represents the seconds.", "type": "integer", "format": "int32" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "BatchAccount" ], "operationId": "BatchAccount_Get", "description": "Gets information about the specified Batch account.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the account." }, { "$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" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts": { "get": { "tags": [ "BatchAccount" ], "operationId": "BatchAccount_List", "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" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts": { "get": { "tags": [ "BatchAccount" ], "operationId": "BatchAccount_ListByResourceGroup", "description": "Gets information about the Batch accounts associated within the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group whose Batch accounts to list." }, { "$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" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys": { "post": { "tags": [ "BatchAccount" ], "operationId": "BatchAccount_SynchronizeAutoStorageKeys", "description": "Synchronizes access keys for the auto storage account configured for the specified Batch account.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "$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" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys": { "post": { "tags": [ "BatchAccount" ], "operationId": "BatchAccount_RegenerateKey", "description": "Regenerates the specified account key for the Batch account.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the account." }, { "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 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}/listKeys": { "post": { "tags": [ "BatchAccount" ], "operationId": "BatchAccount_GetKeys", "description": "Gets the account keys for the specified Batch account.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the account." }, { "$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/{applicationId}/versions/{version}/activate": { "post": { "tags": [ "ApplicationPackage" ], "operationId": "ApplicationPackage_Activate", "description": "Activates the specified application package.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "name": "applicationId", "in": "path", "required": true, "type": "string", "description": "The ID of the application." }, { "name": "version", "in": "path", "required": true, "type": "string", "description": "The version of the application to activate." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ActivateApplicationPackageParameters" }, "description": "The parameters for the request." }, { "$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" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationId}": { "put": { "tags": [ "Application" ], "operationId": "Application_Create", "description": "Adds an application to the specified Batch account.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "name": "applicationId", "in": "path", "required": true, "type": "string", "description": "The ID of the application." }, { "name": "parameters", "in": "body", "required": false, "schema": { "$ref": "#/definitions/AddApplicationParameters" }, "description": "The parameters for the request." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "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" } } } }, "delete": { "tags": [ "Application" ], "operationId": "Application_Delete", "description": "Deletes an application.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "name": "applicationId", "in": "path", "required": true, "type": "string", "description": "The ID of the application." }, { "$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" } } } }, "get": { "tags": [ "Application" ], "operationId": "Application_Get", "description": "Gets information about the specified application.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "name": "applicationId", "in": "path", "required": true, "type": "string", "description": "The ID of the application." }, { "$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" } } } }, "patch": { "tags": [ "Application" ], "operationId": "Application_Update", "description": "Updates settings for the specified application.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "name": "applicationId", "in": "path", "required": true, "type": "string", "description": "The ID of the application." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateApplicationParameters" }, "description": "The parameters for the request." }, { "$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" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationId}/versions/{version}": { "put": { "tags": [ "ApplicationPackage" ], "operationId": "ApplicationPackage_Create", "description": "Creates an application package record.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "name": "applicationId", "in": "path", "required": true, "type": "string", "description": "The ID of the application." }, { "name": "version", "in": "path", "required": true, "type": "string", "description": "The version of the application." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "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" } } } }, "delete": { "tags": [ "ApplicationPackage" ], "operationId": "ApplicationPackage_Delete", "description": "Deletes an application package record and its associated binary file.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "name": "applicationId", "in": "path", "required": true, "type": "string", "description": "The ID of the application." }, { "name": "version", "in": "path", "required": true, "type": "string", "description": "The version of the application to delete." }, { "$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" } } } }, "get": { "tags": [ "ApplicationPackage" ], "operationId": "ApplicationPackage_Get", "description": "Gets information about the specified application package.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "name": "applicationId", "in": "path", "required": true, "type": "string", "description": "The ID of the application." }, { "name": "version", "in": "path", "required": true, "type": "string", "description": "The version of the application." }, { "$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" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications": { "get": { "tags": [ "Application" ], "operationId": "Application_List", "description": "Lists all of the applications in the specified account.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the resource group that contains the Batch account." }, { "name": "accountName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "minLength": 3, "maxLength": 24, "description": "The name of the Batch account." }, { "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" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas": { "get": { "tags": [ "Location" ], "operationId": "Location_GetQuotas", "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 desired region for the quotas." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The operation was successful. The response contains the Batch service quotas of the subscription.", "schema": { "$ref": "#/definitions/BatchLocationQuota" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } } }, "definitions": { "AutoStorageBaseProperties": { "properties": { "storageAccountId": { "type": "string", "description": "The resource ID of the storage account to be used for auto storage account." } }, "required": [ "storageAccountId" ], "description": "The properties related to auto storage account." }, "BatchAccountBaseProperties": { "properties": { "autoStorage": { "$ref": "#/definitions/AutoStorageBaseProperties", "description": "The properties related to auto storage account." } }, "description": "The properties of a Batch account." }, "BatchAccountCreateParameters": { "properties": { "location": { "type": "string", "description": "The region in which to create the account." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The user specified tags associated with the account." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/BatchAccountBaseProperties", "description": "The properties of the account." } }, "required": [ "location" ], "description": "Parameters supplied to the Create operation." }, "AutoStorageProperties": { "properties": { "storageAccountId": { "type": "string", "description": "The resource ID of the storage account to be used for auto storage account." }, "lastKeySync": { "type": "string", "format": "date-time", "description": "The UTC time at which storage keys were last synchronized with the Batch account." } }, "required": [ "storageAccountId", "lastKeySync" ], "description": "Contains information about the auto storage account associated with a Batch account." }, "BatchAccountProperties": { "properties": { "accountEndpoint": { "type": "string", "readOnly": true, "description": "The endpoint used by this account to interact with the Batch services." }, "provisioningState": { "type": "string", "description": "The provisioned state of the resource", "enum": [ "Invalid", "Creating", "Deleting", "Succeeded", "Failed", "Cancelled" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": false } }, "autoStorage": { "$ref": "#/definitions/AutoStorageProperties", "description": "The properties and status of any auto storage account associated with the account." }, "coreQuota": { "type": "integer", "format": "int32", "description": "The core quota for this Batch account." }, "poolQuota": { "type": "integer", "format": "int32", "description": "The pool quota for this Batch account." }, "activeJobAndJobScheduleQuota": { "type": "integer", "format": "int32", "description": "The active job and job schedule quota for this Batch account." } }, "required": [ "coreQuota", "poolQuota", "activeJobAndJobScheduleQuota" ], "description": "Account specific properties." }, "BatchAccount": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/BatchAccountProperties", "description": "The properties associated with the account." } }, "allOf": [ { "$ref": "#/definitions/Resource" } ], "description": "Contains information about an Azure Batch account." }, "BatchAccountUpdateParameters": { "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The user specified tags associated with the account." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/BatchAccountBaseProperties", "description": "The properties of the account." } }, "description": "Parameters supplied to the Update operation." }, "BatchAccountListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/BatchAccount" }, "description": "The collection of returned Batch accounts." }, "nextLink": { "type": "string", "description": "The continuation token." } }, "description": "Values returned by the List operation." }, "BatchAccountRegenerateKeyParameters": { "properties": { "keyName": { "type": "string", "description": "The type of account key to regenerate.", "enum": [ "Primary", "Secondary" ], "x-ms-enum": { "name": "AccountKeyType", "modelAsString": false } } }, "required": [ "keyName" ], "description": "Parameters supplied to the RegenerateKey operation." }, "BatchAccountKeys": { "properties": { "primary": { "type": "string", "description": "The primary key associated with the account." }, "secondary": { "type": "string", "description": "The secondary key associated with the account." } }, "description": "A set of Azure Batch account keys." }, "ActivateApplicationPackageParameters": { "properties": { "format": { "type": "string", "description": "The format of the application package binary file." } }, "required": [ "format" ], "description": "Parameters for an ApplicationOperations.ActivateApplicationPackage request." }, "AddApplicationParameters": { "properties": { "allowUpdates": { "type": "boolean", "description": "A value indicating whether packages within the application may be overwritten using the same version string." }, "displayName": { "type": "string", "description": "The display name for the application." } }, "description": "Parameters for an ApplicationOperations.AddApplication request." }, "Application": { "properties": { "id": { "type": "string", "description": "A string that uniquely identifies the application within the account." }, "displayName": { "type": "string", "description": "The display name for the application." }, "packages": { "type": "array", "items": { "$ref": "#/definitions/ApplicationPackage" }, "description": "The list of packages under this application." }, "allowUpdates": { "type": "boolean", "description": "A value indicating whether packages within the application may be overwritten using the same version string." }, "defaultVersion": { "type": "string", "description": "The package to use if a client requests the application but does not specify a version." } }, "description": "Contains information about an application in a Batch account." }, "ApplicationPackage": { "properties": { "id": { "type": "string", "description": "The ID of the application." }, "version": { "type": "string", "description": "The version of the application package. " }, "state": { "type": "string", "description": "The current state of the application package.", "enum": [ "pending", "active", "unmapped" ], "x-ms-enum": { "name": "PackageState", "modelAsString": false } }, "format": { "type": "string", "description": "The format of the application package, if the package is active." }, "storageUrl": { "type": "string", "description": "The storage URL at which the application package is stored." }, "storageUrlExpiry": { "type": "string", "format": "date-time", "description": "The UTC time at which the storage URL will expire." }, "lastActivationTime": { "type": "string", "format": "date-time", "description": "The time at which the package was last activated, if the package is active." } }, "description": "An application package which represents a particular version of an application." }, "ListApplicationsResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Application" }, "description": "The list of applications." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response to an ApplicationOperations.ListApplications request." }, "UpdateApplicationParameters": { "properties": { "allowUpdates": { "type": "boolean", "description": "A value indicating whether packages within the application may be overwritten using the same version string." }, "defaultVersion": { "type": "string", "description": "The package to use if a client requests the application but does not specify a version." }, "displayName": { "type": "string", "description": "The display name for the application." } }, "description": "Parameters for an ApplicationOperations.UpdateApplication request." }, "BatchLocationQuota": { "properties": { "accountQuota": { "type": "integer", "format": "int32", "description": "The number of Batch accounts that may be created under the subscription in the specified region." } }, "description": "Quotas associated with a Batch region for a particular subscription." }, "Resource": { "properties": { "id": { "readOnly": true, "type": "string", "description": "The ID of the resource" }, "name": { "readOnly": true, "type": "string", "description": "The name of the resource" }, "type": { "readOnly": true, "type": "string", "description": "The type of the resource" }, "location": { "type": "string", "description": "The location of the resource" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The tags of the resource" } }, "description": "A definition of an Azure resource.", "x-ms-azure-resource": true }, "CloudError": { "x-ms-external": true, "properties": { "code": { "type": "string", "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "A message describing the error, intended to be suitable for display in a user interface." }, "target": { "type": "string", "description": "The target of the particular error. For example, the name of the property in error." }, "details": { "type": "array", "items": { "$ref": "#/definitions/CloudError" }, "description": "A list of additional details about the error." } }, "description": "An error response from the Batch service." } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "A unique identifier of a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "The API version to be used with the HTTP request." } } }