openapi-directory/api/azure.com/batch-BatchManagement.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"BatchManagement","version":"2019-08-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-ms-code-generation-settings":{"name":"BatchManagementClient"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/batch/resource-manager/Microsoft.Batch/stable/2019-08-01/BatchManagement.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"batch-BatchManagement","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.Batch/operations":{"get":{"description":"Lists available operations for the Microsoft.Batch provider","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the list of available operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts":{"get":{"description":"Gets information about the Batch accounts associated with the subscription.","operationId":"BatchAccount_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains a list of Batch account entities associated with the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccountListResult"},"examples":{"BatchAccountList":{"$ref":"#/components/examples/BatchAccountList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["BatchAccount"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability":{"post":{"description":"Checks whether the Batch account name is available in the specified region.","operationId":"Location_CheckNameAvailability","parameters":[{"description":"The desired region for the name check.","in":"path","name":"locationName","required":true,"schema":{"type":"string"},"examples":{"LocationCheckNameAvailability_AlreadyExists":{"value":"japaneast"},"LocationCheckNameAvailability_Available":{"value":"japaneast"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityParameters"}}},"description":"Properties needed to check the availability of a name.","required":true},"responses":{"200":{"description":"Success. Returns details about whether a Batch account name is available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityResult"},"examples":{"LocationCheckNameAvailability_AlreadyExists":{"$ref":"#/components/examples/LocationCheckNameAvailability_AlreadyExists"},"LocationCheckNameAvailability_Available":{"$ref":"#/components/examples/LocationCheckNameAvailability_Available"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas":{"get":{"description":"Gets the Batch service quotas for the specified subscription at the given location.","operationId":"Location_GetQuotas","parameters":[{"description":"The region for which to retrieve Batch service quotas.","in":"path","name":"locationName","required":true,"schema":{"type":"string"},"examples":{"LocationGetQuotas":{"value":"japaneast"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the Batch service quotas for the subscription in the specified location.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchLocationQuota"},"examples":{"LocationGetQuotas":{"$ref":"#/components/examples/LocationGetQuotas"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Location"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts":{"get":{"description":"Gets information about the Batch accounts associated with the specified resource group.","operationId":"BatchAccount_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains a list of Batch account entities associated with the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccountListResult"},"examples":{"BatchAccountListByResourceGroup":{"$ref":"#/components/examples/BatchAccountListByResourceGroup"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["BatchAccount"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}":{"delete":{"description":"Deletes the specified Batch account.","operationId":"BatchAccount_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/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.","schema":{"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.","schema":{"type":"integer","format":"int32"}}}},"204":{"description":"NoContent -- account does not exist in the subscription."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["BatchAccount"],"x-ms-long-running-operation":true},"get":{"description":"Gets information about the specified Batch account.","operationId":"BatchAccount_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the Batch account entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccount"},"examples":{"BatchAccountGet":{"$ref":"#/components/examples/BatchAccountGet"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["BatchAccount"]},"patch":{"description":"Updates the properties of an existing Batch account.","operationId":"BatchAccount_Update","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccountUpdateParameters"}}},"description":"Additional parameters for account update.","required":true},"responses":{"200":{"description":"The operation was successful. The response contains the Batch account entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccount"},"examples":{"BatchAccountUpdate":{"$ref":"#/components/examples/BatchAccountUpdate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["BatchAccount"]},"put":{"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.","operationId":"BatchAccount_Create","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"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/.","in":"path","name":"accountName","required":true,"schema":{"type":"string","minLength":3,"maxLength":24,"pattern":"^[-\\w\\._]+$"},"examples":{"BatchAccountCreate_BYOS":{"value":"sampleacct"},"BatchAccountCreate_Default":{"value":"sampleacct"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccountCreateParameters"}}},"description":"Additional parameters for account creation.","required":true},"responses":{"200":{"description":"The operation was successful. The response contains the Batch account entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccount"},"examples":{"BatchAccountCreate_BYOS":{"$ref":"#/components/examples/BatchAccountCreate_BYOS"},"BatchAccountCreate_Default":{"$ref":"#/components/examples/BatchAccountCreate_Default"}}}}},"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.","schema":{"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.","schema":{"type":"integer","format":"int32"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["BatchAccount"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications":{"get":{"description":"Lists all of the applications in the specified account.","operationId":"Application_List","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"description":"The maximum number of items to return in the response.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains a list of the application entities associated with the specified account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApplicationsResult"},"examples":{"ApplicationList":{"$ref":"#/components/examples/ApplicationList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Application"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}":{"delete":{"description":"Deletes an application.","operationId":"Application_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApplicationNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful."},"204":{"description":"The operation was successful."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Application"]},"get":{"description":"Gets information about the specified application.","operationId":"Application_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApplicationNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the application entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"},"examples":{"ApplicationGet":{"$ref":"#/components/examples/ApplicationGet"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Application"]},"patch":{"description":"Updates settings for the specified application.","operationId":"Application_Update","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApplicationNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}},"description":"The parameters for the request.","required":true},"responses":{"200":{"description":"The operation was successful. The response contains the application entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"},"examples":{"ApplicationUpdate":{"$ref":"#/components/examples/ApplicationUpdate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Application"]},"put":{"description":"Adds an application to the specified Batch account.","operationId":"Application_Create","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApplicationNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}},"description":"The parameters for the request."},"responses":{"200":{"description":"The operation was successful. The response contains the application entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"},"examples":{"ApplicationCreate":{"$ref":"#/components/examples/ApplicationCreate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Application"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions":{"get":{"description":"Lists all of the application packages in the specified application.","operationId":"ApplicationPackage_List","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApplicationNameParameter"},{"description":"The maximum number of items to return in the response.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains a list of the application package entities associated with the specified application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApplicationPackagesResult"},"examples":{"ApplicationList":{"$ref":"#/components/examples/ApplicationList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ApplicationPackage"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}":{"delete":{"description":"Deletes an application package record and its associated binary file.","operationId":"ApplicationPackage_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApplicationNameParameter"},{"$ref":"#/components/parameters/VersionNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful."},"204":{"description":"The operation was successful."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ApplicationPackage"]},"get":{"description":"Gets information about the specified application package.","operationId":"ApplicationPackage_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApplicationNameParameter"},{"$ref":"#/components/parameters/VersionNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the application package entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPackage"},"examples":{"ApplicationPackageGet":{"$ref":"#/components/examples/ApplicationPackageGet"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ApplicationPackage"]},"put":{"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.","operationId":"ApplicationPackage_Create","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApplicationNameParameter"},{"$ref":"#/components/parameters/VersionNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPackage"}}},"description":"The parameters for the request."},"responses":{"200":{"description":"The operation was successful. The response contains the application package entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPackage"},"examples":{"ApplicationPackageCreate":{"$ref":"#/components/examples/ApplicationPackageCreate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ApplicationPackage"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}/activate":{"post":{"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","operationId":"ApplicationPackage_Activate","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApplicationNameParameter"},{"$ref":"#/components/parameters/VersionNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateApplicationPackageParameters"}}},"description":"The parameters for the request.","required":true},"responses":{"200":{"description":"The operation was successful. The response contains the application package entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPackage"},"examples":{"ApplicationPackageActivate":{"$ref":"#/components/examples/ApplicationPackageActivate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ApplicationPackage"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates":{"get":{"description":"Lists all of the certificates in the specified account.","operationId":"Certificate_ListByBatchAccount","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"description":"The maximum number of items to return in the response.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection.","in":"query","name":"$select","required":false,"schema":{"type":"string"},"examples":{"ListCertificates - Filter and Select":{"value":"properties/format,properties/provisioningState"}}},{"description":"OData filter expression. Valid properties for filtering are \"properties/provisioningState\", \"properties/provisioningStateTransitionTime\", \"name\".","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"ListCertificates - Filter and Select":{"value":"properties/provisioningStateTransitionTime gt '2017-05-01' or properties/provisioningState eq 'Failed'"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains a list of certificates associated with the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCertificatesResult"},"examples":{"ListCertificates":{"$ref":"#/components/examples/ListCertificates"},"ListCertificates - Filter and Select":{"$ref":"#/components/examples/ListCertificates_-_Filter_and_Select"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Certificate"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}":{"delete":{"description":"Deletes the specified certificate.","operationId":"Certificate_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/CertificateNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/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.","schema":{"type":"string"},"example":"https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/certificateOperationResults/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e-8D4EDFF164A11C9?api-version=2019-08-01"},"Retry-After":{"description":"Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.","schema":{"type":"integer","format":"int32"},"example":"15"}}},"204":{"description":"The operation was successful."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Certificate"],"x-ms-long-running-operation":true},"get":{"description":"Gets information about the specified certificate.","operationId":"Certificate_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/CertificateNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the certificate entity.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.","schema":{"type":"string"},"example":"W/\"0x8D4EDD5118668F7\""}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"Get Certificate":{"$ref":"#/components/examples/Get_Certificate"},"Get Certificate with Deletion Error":{"$ref":"#/components/examples/Get_Certificate_with_Deletion_Error"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Certificate"]},"patch":{"description":"Updates the properties of an existing certificate.","operationId":"Certificate_Update","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/CertificateNameParameter"},{"description":"The entity state (ETag) version of the certificate to update. This value can be omitted or set to \"*\" to apply the operation unconditionally.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateCreateOrUpdateParameters"}}},"description":"Certificate entity to update.","required":true},"responses":{"200":{"description":"The operation was successful. The response contains the certificate entity.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.","schema":{"type":"string"},"example":"W/\"0x8D4EDD5118668F7\""}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"UpdateCertificate":{"$ref":"#/components/examples/UpdateCertificate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Certificate"]},"put":{"description":"Creates a new certificate inside the specified account.","operationId":"Certificate_Create","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/CertificateNameParameter"},{"description":"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.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}},{"description":"Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored.","in":"header","name":"If-None-Match","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateCreateOrUpdateParameters"}}},"description":"Additional parameters for certificate creation.","required":true},"responses":{"200":{"description":"The operation was successful. The response contains the certificate entity.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.","schema":{"type":"string"},"example":"W/\"0x8D4EDD5118668F7\""}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"CreateCertificate - Full":{"$ref":"#/components/examples/CreateCertificate_-_Full"},"CreateCertificate - Minimal Cer":{"$ref":"#/components/examples/CreateCertificate_-_Minimal_Cer"},"CreateCertificate - Minimal Pfx":{"$ref":"#/components/examples/CreateCertificate_-_Minimal_Pfx"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Certificate"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}/cancelDelete":{"post":{"description":"If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.","operationId":"Certificate_CancelDeletion","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/CertificateNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the certificate entity.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.","schema":{"type":"string"},"example":"W/\"0x8D4EDD513C3EDBB\""}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"CertificateCancelDeletion":{"$ref":"#/components/examples/CertificateCancelDeletion"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Cancels a failed deletion of a certificate from the specified account.","tags":["Certificate"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys":{"post":{"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.","operationId":"BatchAccount_GetKeys","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the keys of the Batch account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccountKeys"},"examples":{"BatchAccountGetKeys":{"$ref":"#/components/examples/BatchAccountGetKeys"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Gets the account keys for the specified Batch account.","tags":["BatchAccount"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools":{"get":{"description":"Lists all of the pools in the specified account.","operationId":"Pool_ListByBatchAccount","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"description":"The maximum number of items to return in the response.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection.","in":"query","name":"$select","required":false,"schema":{"type":"string"},"examples":{"ListPoolWithFilter":{"value":"properties/allocationState,properties/provisioningStateTransitionTime,properties/currentDedicatedNodes,properties/currentLowPriorityNodes"}}},{"description":"OData filter expression. Valid properties for filtering are:\n\n name\n properties/allocationState\n properties/allocationStateTransitionTime\n properties/creationTime\n properties/provisioningState\n properties/provisioningStateTransitionTime\n properties/lastModified\n properties/vmSize\n properties/interNodeCommunication\n properties/scaleSettings/autoScale\n properties/scaleSettings/fixedScale","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"ListPoolWithFilter":{"value":"startswith(name, 'po') or (properties/allocationState eq 'Steady' and properties/provisioningStateTransitionTime lt datetime'2017-02-02')"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains a list of certificates associated with the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPoolsResult"},"examples":{"ListPool":{"$ref":"#/components/examples/ListPool"},"ListPoolWithFilter":{"$ref":"#/components/examples/ListPoolWithFilter"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Pool"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}":{"delete":{"description":"Deletes the specified pool.","operationId":"Pool_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/PoolNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/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.","schema":{"type":"string"},"example":"https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/poolOperationResults/delete-testpool-8D4EDFF164A11C9?api-version=2019-08-01"},"Retry-After":{"description":"Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.","schema":{"type":"integer","format":"int32"},"example":"15"}}},"204":{"description":"The operation was successful."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Pool"],"x-ms-long-running-operation":true},"get":{"description":"Gets information about the specified pool.","operationId":"Pool_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/PoolNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the pool entity.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.","schema":{"type":"string"},"example":"W/\"0x8D4EDFEBFADF4AB\""}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pool"},"examples":{"GetPool":{"$ref":"#/components/examples/GetPool"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Pool"]},"patch":{"description":"Updates the properties of an existing pool.","operationId":"Pool_Update","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/PoolNameParameter"},{"description":"The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pool"}}},"description":"Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.","required":true},"responses":{"200":{"description":"The operation was successful. The response contains the pool entity.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.","schema":{"type":"string"},"example":"W/\"0x8D4EDFEBFADF4AB\""}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pool"},"examples":{"UpdatePool - Enable Autoscale":{"$ref":"#/components/examples/UpdatePool_-_Enable_Autoscale"},"UpdatePool - Other Properties":{"$ref":"#/components/examples/UpdatePool_-_Other_Properties"},"UpdatePool - Remove Start Task":{"$ref":"#/components/examples/UpdatePool_-_Remove_Start_Task"},"UpdatePool - Resize Pool":{"$ref":"#/components/examples/UpdatePool_-_Resize_Pool"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Pool"]},"put":{"description":"Creates a new pool inside the specified account.","operationId":"Pool_Create","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/PoolNameParameter"},{"description":"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.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}},{"description":"Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.","in":"header","name":"If-None-Match","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pool"}}},"description":"Additional parameters for pool creation.","required":true},"responses":{"200":{"description":"The operation was successful. The response contains the pool entity.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.","schema":{"type":"string"},"example":"W/\"0x8D4EDFEBFADF4AB\""}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pool"},"examples":{"CreatePool - Custom Image":{"$ref":"#/components/examples/CreatePool_-_Custom_Image"},"CreatePool - Full Example":{"$ref":"#/components/examples/CreatePool_-_Full_Example"},"CreatePool - Full VirtualMachineConfiguration":{"$ref":"#/components/examples/CreatePool_-_Full_VirtualMachineConfiguration"},"CreatePool - Minimal CloudServiceConfiguration":{"$ref":"#/components/examples/CreatePool_-_Minimal_CloudServiceConfiguration"},"CreatePool - Minimal VirtualMachineConfiguration":{"$ref":"#/components/examples/CreatePool_-_Minimal_VirtualMachineConfiguration"},"CreatePool - Public IPs":{"$ref":"#/components/examples/CreatePool_-_Public_IPs"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Pool"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale":{"post":{"description":"Disables automatic scaling for a pool.","operationId":"Pool_DisableAutoScale","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/PoolNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the pool entity.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.","schema":{"type":"string"},"example":"W/\"0x8D4EDFEBFADF4AB\""}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pool"},"examples":{"Disable AutoScale":{"$ref":"#/components/examples/Disable_AutoScale"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["Pool"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize":{"post":{"description":"This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.","operationId":"Pool_StopResize","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/PoolNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The operation was successful. The response contains the pool entity.","headers":{"ETag":{"description":"The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.","schema":{"type":"string"},"example":"W/\"0x8D4EDFEBFADF4AB\""}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pool"},"examples":{"StopPoolResize":{"$ref":"#/components/examples/StopPoolResize"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Stops an ongoing resize operation on the pool.","tags":["Pool"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys":{"post":{"description":"Regenerates the specified account key for the Batch account.","operationId":"BatchAccount_RegenerateKey","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccountRegenerateKeyParameters"}}},"description":"The type of key to regenerate.","required":true},"responses":{"200":{"description":"The operation was successful. The response contains the Batch account keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAccountKeys"},"examples":{"BatchAccountRegenerateKey":{"$ref":"#/components/examples/BatchAccountRegenerateKey"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["BatchAccount"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys":{"post":{"description":"Synchronizes access keys for the auto-storage account configured for the specified Batch account.","operationId":"BatchAccount_SynchronizeAutoStorageKeys","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"The operation was successful."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["BatchAccount"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"BatchAccountList":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct","location":"japaneast","name":"sampleacct","properties":{"accountEndpoint":"sampleacct.japaneast.batch.azure.com","activeJobAndJobScheduleQuota":20,"autoStorage":{"lastKeySync":"2016-03-10T23:48:38.9878479Z","storageAccountId":"/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Stor