swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector ComputeNodes API schemes: - https tags: - name: ComputeNodes paths: /pools/{poolId}/removenodes: post: tags: - ComputeNodes operationId: microsoftAzurePoolRemovenodes x-ms-examples: Pool remove nodes: $ref: ./examples/PoolRemoveNodes.json summary: Microsoft Azure Removes Compute Nodes From The Specified Pool description: This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes. x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool from which you want to remove Compute Nodes. - name: nodeRemoveParameter in: body required: true schema: $ref: '#/definitions/NodeRemoveParameter' description: The parameters for the request. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - name: If-Match in: header required: false type: string description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. x-ms-parameter-grouping: postfix: Options - name: If-None-Match in: header required: false type: string description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. x-ms-parameter-grouping: postfix: Options - name: If-Modified-Since in: header required: false type: string format: date-time-rfc1123 description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. x-ms-parameter-grouping: postfix: Options - name: If-Unmodified-Since in: header required: false type: string format: date-time-rfc1123 description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '202': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes/{nodeId}/users: post: tags: - ComputeNodes operationId: microsoftAzureComputenodeAdduser x-ms-examples: Node add user: $ref: ./examples/NodeAddUser.json summary: Microsoft Azure Adds A User Account To The Specified Compute Node description: You can add a user Account to a Compute Node only when it is in the idle or running state. x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the machine on which you want to create a user Account. - name: user in: body description: The user Account to be created. required: true schema: $ref: '#/definitions/ComputeNodeUser' - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '201': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes/{nodeId}/users/{userName}: delete: tags: - ComputeNodes operationId: microsoftAzureComputenodeDeleteuser x-ms-examples: Node delete user: $ref: ./examples/NodeDeleteUser.json summary: Microsoft Azure Deletes A User Account From The Specified Compute Node description: You can delete a user Account to a Compute Node only when it is in the idle or running state. x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the machine on which you want to delete a user Account. - name: userName in: path required: true type: string description: The name of the user Account to delete. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' put: tags: - ComputeNodes operationId: microsoftAzureComputenodeUpdateuser x-ms-examples: Node update user: $ref: ./examples/NodeUpdateUser.json summary: Microsoft Azure Updates The Password And Expiration Time Of A User Account On The Specified Compute Node description: This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state. x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the machine on which you want to update a user Account. - name: userName in: path required: true type: string description: The name of the user Account to update. - name: nodeUpdateUserParameter in: body required: true schema: $ref: '#/definitions/NodeUpdateUserParameter' description: The parameters for the request. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes/{nodeId}: get: tags: - ComputeNodes operationId: microsoftAzureComputenodeGet x-ms-examples: Node get: $ref: ./examples/NodeGet_Basic.json summary: Microsoft Azure Gets Information About The Specified Compute Node x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node that you want to get information about. - name: $select in: query required: false type: string description: An OData $select clause. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the Compute Node. schema: $ref: '#/definitions/ComputeNode' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' description: Needs a more full description created. /pools/{poolId}/nodes/{nodeId}/reboot: post: tags: - ComputeNodes operationId: microsoftAzureComputenodeReboot x-ms-examples: Node reboot: $ref: ./examples/NodeReboot.json summary: Microsoft Azure Restarts The Specified Compute Node description: You can restart a Compute Node only if it is in an idle or running state. x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node that you want to restart. - name: nodeRebootParameter in: body required: false schema: $ref: '#/definitions/NodeRebootParameter' description: The parameters for the request. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '202': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes/{nodeId}/reimage: post: tags: - ComputeNodes operationId: microsoftAzureComputenodeReimage x-ms-examples: Node reimage: $ref: ./examples/NodeReimage.json summary: Microsoft Azure Reinstalls The Operating System On The Specified Compute Node description: You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property. x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node that you want to restart. - name: nodeReimageParameter in: body required: false schema: $ref: '#/definitions/NodeReimageParameter' description: The parameters for the request. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '202': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes/{nodeId}/disablescheduling: post: tags: - ComputeNodes operationId: microsoftAzureComputenodeDisablescheduling x-ms-examples: Node disable scheduling: $ref: ./examples/NodeDisableScheduling.json summary: Microsoft Azure Disables Task Scheduling On The Specified Compute Node description: You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled. x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node on which you want to disable Task scheduling. - name: nodeDisableSchedulingParameter in: body required: false schema: $ref: '#/definitions/NodeDisableSchedulingParameter' description: The parameters for the request. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes/{nodeId}/enablescheduling: post: tags: - ComputeNodes operationId: microsoftAzureComputenodeEnablescheduling x-ms-examples: Node enable scheduling: $ref: ./examples/NodeEnableScheduling.json summary: Microsoft Azure Enables Task Scheduling On The Specified Compute Node description: You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node on which you want to enable Task scheduling. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes/{nodeId}/remoteloginsettings: get: tags: - ComputeNodes operationId: microsoftAzureComputenodeGetremoteloginsettings x-ms-examples: Node get remote login settings: $ref: ./examples/NodeGetRemoteLoginSettings.json summary: Microsoft Azure Gets The Settings Required For Remote Login To A Compute Node description: Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node. This API can be invoked only on Pools created with the virtual machine configuration property. For Pools created with a cloud service configuration, see the GetRemoteDesktop API. x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node for which to obtain the remote login settings. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the login settings. schema: $ref: '#/definitions/ComputeNodeGetRemoteLoginSettingsResult' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes/{nodeId}/rdp: get: tags: - ComputeNodes operationId: microsoftAzureComputenodeGetremotedesktop x-ms-examples: Get RDP file of the compute node: $ref: ./examples/NodeGetRemoteDesktop.json summary: Microsoft Azure Gets The Remote Desktop Protocol File For The Specified Compute Node description: Before you can access a Compute Node by using the RDP file, you must create a user Account on the Compute Node. This API can only be invoked on Pools created with a cloud service configuration. For Pools created with a virtual machine configuration, see the GetRemoteLoginSettings API. x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node for which you want to get the Remote Desktop Protocol file. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' produces: - application/json - application/octet-stream responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the RDP information. schema: type: object format: file default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs: post: tags: - ComputeNodes operationId: microsoftAzureComputenodeUploadbatchservicelogs summary: Microsoft Azure Upload Azure Batch Service Log Files From The Specified Compute Node To Azure Blob Storage description: This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. x-ms-examples: Upload BatchService Logs: $ref: ./examples/NodeUploadBatchServiceLogs.json x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node from which you want to upload the Azure Batch service log files. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - name: uploadBatchServiceLogsConfiguration in: body description: The Azure Batch service log files upload configuration. required: true schema: $ref: '#/definitions/UploadBatchServiceLogsConfiguration' - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid description: The request to the Batch service was successful. schema: $ref: '#/definitions/UploadBatchServiceLogsResult' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /pools/{poolId}/nodes: get: tags: - ComputeNodes x-ms-pageable: nextLinkName: odata.nextLink operationId: microsoftAzureComputenodeList x-ms-examples: Node list: $ref: ./examples/NodeList.json summary: Microsoft Azure Lists The Compute Nodes In The Specified Pool x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool from which you want to list Compute Nodes. - name: $filter in: query required: false type: string description: An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. x-ms-parameter-grouping: postfix: Options - name: $select in: query required: false type: string description: An OData $select clause. x-ms-parameter-grouping: postfix: Options - name: maxresults x-ms-client-name: maxResults default: 1000 minimum: 1 maximum: 1000 in: query required: false type: integer format: int32 description: The maximum number of items to return in the response. A maximum of 1000 Compute Nodes can be returned. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the list of Compute Nodes. schema: $ref: '#/definitions/ComputeNodeListResult' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' description: Needs a more full description created. /pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}: get: tags: - ComputeNodes operationId: microsoftAzureComputenodeextensionGet x-ms-examples: Get compute node extension: $ref: ./examples/ComputeNodeExtensionGet.json summary: Microsoft Azure Gets Information About The Specified Compute Node Extension x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains the Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node that contains the extensions. - name: extensionName in: path required: true type: string description: The name of the of the Compute Node Extension that you want to get information about. - name: $select in: query required: false type: string description: An OData $select clause. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the Compute Node Extension. schema: $ref: '#/definitions/NodeVMExtension' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError_2' description: Needs a more full description created. /pools/{poolId}/nodes/{nodeId}/extensions: get: tags: - ComputeNodes x-ms-pageable: nextLinkName: odata.nextLink operationId: microsoftAzureComputenodeextensionList x-ms-examples: List compute node extensions: $ref: ./examples/ComputeNodeExtensionList.json summary: Microsoft Azure Lists The Compute Nodes Extensions In The Specified Pool x-ms-request-id: request-id parameters: - name: poolId in: path required: true type: string description: The ID of the Pool that contains Compute Node. - name: nodeId in: path required: true type: string description: The ID of the Compute Node that you want to list extensions. - name: $select in: query required: false type: string description: An OData $select clause. x-ms-parameter-grouping: postfix: Options - name: maxresults x-ms-client-name: maxResults default: 1000 minimum: 1 maximum: 1000 in: query required: false type: integer format: int32 description: The maximum number of items to return in the response. A maximum of 1000 Compute Nodes can be returned. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid 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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the list of Compute Nodes. schema: $ref: '#/definitions/NodeVMExtensionList' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError_2' description: Needs a more full description created. definitions: ErrorMessage: properties: lang: type: string title: The language code of the error message value: type: string title: The text of the message. title: An error message received in an Azure Batch error response. ComputeNodeDeallocationOption: type: string title: Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation. description: The default value is requeue. enum: - requeue - terminate - taskcompletion - retaineddata x-ms-enum: name: ComputeNodeDeallocationOption modelAsString: false values: - value: requeue description: Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Remove Compute Nodes as soon as Tasks have been terminated. - value: terminate description: Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove Compute Nodes as soon as Tasks have been terminated. - value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Remove Compute Nodes when all Tasks have completed. name: taskCompletion - value: retaineddata description: Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Remove Compute Nodes when all Task retention periods have expired. name: retainedData ComputeNodeListResult: properties: value: type: array items: $ref: '#/definitions/ComputeNode' title: The list of Compute Nodes. odata.nextLink: type: string title: The URL to get the next set of results. title: The result of listing the Compute Nodes in a Pool. ComputeNodeGetRemoteLoginSettingsResult: properties: remoteLoginIPAddress: type: string title: The IP address used for remote login to the Compute Node. remoteLoginPort: type: integer format: int32 title: The port used for remote login to the Compute Node. required: - remoteLoginIPAddress - remoteLoginPort title: The remote login settings for a Compute Node. NodeRemoveParameter: properties: nodeList: type: array maxItems: 100 items: type: string title: A list containing the IDs of the Compute Nodes to be removed from the specified Pool. description: A maximum of 100 nodes may be removed per request. resizeTimeout: type: string format: duration title: The timeout for removal of Compute Nodes to the Pool. description: The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). nodeDeallocationOption: title: Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation. description: The default value is requeue. $ref: '#/definitions/ComputeNodeDeallocationOption' required: - nodeList title: Options for removing Compute Nodes from a Pool. UserIdentity: properties: username: type: string x-ms-client-name: userName title: The name of the user identity under which the Task is run. description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. autoUser: $ref: '#/definitions/AutoUserSpecification' title: The auto user under which the Task is run. description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. title: The definition of the user identity under which the Task is run. description: Specify either the userName or autoUser property, but not both. BatchErrorDetail_2: type: object properties: key: type: string title: An identifier specifying the meaning of the Value property. value: type: string title: The additional information included with the error response. title: An item of additional information included in an Azure Batch error response. NodeUpdateUserParameter: properties: password: type: string title: The password of the Account. description: The password is required for Windows Compute Nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed. expiryTime: type: string format: date-time title: The time at which the Account should expire. description: If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day. sshPublicKey: type: string title: The SSH public key that can be used for remote login to the Compute Node. description: The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed. title: The set of changes to be made to a user Account on a Compute Node. TaskContainerSettings: properties: containerRunOptions: type: string title: Additional options to the container create command. description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. imageName: type: string title: The Image to use to create the container in which the Task will run. description: This is the full Image reference, as would be specified to "docker pull". If no tag is provided as part of the Image name, the tag ":latest" is used as a default. registry: $ref: '#/definitions/ContainerRegistry' title: The private registry which contains the container Image. description: This setting can be omitted if was already provided at Pool creation. workingDirectory: type: string title: The location of the container Task working directory. description: The default is 'taskWorkingDirectory'. enum: - taskWorkingDirectory - containerImageDefault x-ms-enum: name: ContainerWorkingDirectory modelAsString: false values: - value: taskWorkingDirectory description: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. - value: containerImageDefault description: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. required: - imageName title: The container settings for a Task. NodeVMExtension: type: object properties: provisioningState: type: string title: The provisioning state of the virtual machine extension. vmExtension: $ref: '#/definitions/VMExtension' title: The virtual machine extension instanceView: $ref: '#/definitions/VMExtensionInstanceView' title: The vm extension instance view. title: The configuration for virtual machine extension instance view. ComputeNodeUser: properties: name: type: string title: The user name of the Account. isAdmin: type: boolean title: Whether the Account should be an administrator on the Compute Node. description: The default value is false. expiryTime: type: string format: date-time title: The time at which the Account should expire. description: If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day. password: type: string title: The password of the Account. description: The password is required for Windows Compute Nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. sshPublicKey: type: string title: The SSH public key that can be used for remote login to the Compute Node. description: The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). required: - name title: A user Account for RDP or SSH access on a Compute Node. BatchError_2: type: object properties: code: type: string title: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/ErrorMessage_2' title: A message describing the error, intended to be suitable for display in a user interface. values: type: array items: $ref: '#/definitions/BatchErrorDetail_2' title: A collection of key-value pairs containing additional details about the error. title: An error response received from the Azure Batch service. AutoUserSpecification: properties: scope: type: string title: The scope for the auto user description: The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks. enum: - task - pool x-ms-enum: name: AutoUserScope modelAsString: false values: - value: task description: Specifies that the service should create a new user for the Task. - value: pool description: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. elevationLevel: title: The elevation level of the auto user. description: The default value is nonAdmin. $ref: '#/definitions/ElevationLevel' title: Specifies the parameters for the auto user that runs a Task on the Batch service. BatchError: properties: code: type: string title: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/ErrorMessage' title: A message describing the error, intended to be suitable for display in a user interface. values: type: array items: $ref: '#/definitions/BatchErrorDetail' title: A collection of key-value pairs containing additional details about the error. title: An error response received from the Azure Batch service. ContainerRegistry: properties: registryServer: type: string title: The registry URL. description: If omitted, the default is "docker.io". username: type: string x-ms-client-name: userName title: The user name to log into the registry server. password: type: string title: The password to log into the registry server. required: - username - password title: A private container registry. InstanceViewStatus: type: object properties: code: type: string title: The status code. displayStatus: type: string title: The localized label for the status. level: type: string title: Level code. enum: - Error - Info - Warning x-ms-enum: name: StatusLevelTypes modelAsString: false values: - value: Error - value: Info - value: Warning message: type: string title: The detailed status message. time: type: string description: The time of the status. title: The instance view status. InboundEndpoint: properties: name: type: string title: The name of the endpoint. protocol: $ref: '#/definitions/InboundEndpointProtocol' title: The protocol of the endpoint. publicIPAddress: type: string title: The public IP address of the Compute Node. publicFQDN: type: string title: The public fully qualified domain name for the Compute Node. frontendPort: type: integer format: int32 title: The public port number of the endpoint. backendPort: type: integer format: int32 title: The backend port number of the endpoint. required: - name - protocol - publicIPAddress - publicFQDN - frontendPort - backendPort title: An inbound endpoint on a Compute Node. EnvironmentSetting: properties: name: type: string title: The name of the environment variable. value: type: string title: The value of the environment variable. required: - name title: An environment variable to be set on a Task process. ElevationLevel: type: string title: The elevation level of the user. enum: - nonadmin - admin x-ms-enum: name: ElevationLevel modelAsString: false values: - value: nonadmin description: The user is a standard user without elevated access. name: nonAdmin - value: admin description: The user is a user with elevated access and operates with full Administrator permissions. UploadBatchServiceLogsResult: properties: virtualDirectoryName: type: string title: The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded. description: The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and a unique identifier. numberOfFilesUploaded: type: integer format: int32 title: The number of log files which will be uploaded. required: - virtualDirectoryName - numberOfFilesUploaded title: The result of uploading Batch service log files from a specific Compute Node. CertificateReference: properties: thumbprint: type: string title: The thumbprint of the Certificate. thumbprintAlgorithm: type: string title: The algorithm with which the thumbprint is associated. This must be sha1. storeLocation: type: string title: The location of the Certificate store on the Compute Node into which to install the Certificate. description: The default value is currentuser. This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory. enum: - currentuser - localmachine x-ms-enum: name: CertificateStoreLocation modelAsString: false values: - value: currentuser description: Certificates should be installed to the CurrentUser Certificate store. name: currentUser - value: localmachine description: Certificates should be installed to the LocalMachine Certificate store. name: localMachine storeName: type: string title: The name of the Certificate store on the Compute Node into which to install the Certificate. description: 'This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.' visibility: type: array items: type: string x-nullable: false enum: - starttask - task - remoteuser x-ms-enum: name: CertificateVisibility modelAsString: false values: - value: starttask description: The Certificate should be visible to the user account under which the StartTask is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well. name: startTask - value: task description: The Certificate should be visible to the user accounts under which Job Tasks are run. - value: remoteuser description: The Certificate should be visible to the user accounts under which users remotely access the Compute Node. name: remoteUser title: Which user Accounts on the Compute Node should have access to the private data of the Certificate. description: You can specify more than one visibility in this collection. The default is all Accounts. required: - thumbprint - thumbprintAlgorithm title: A reference to a Certificate to be installed on Compute Nodes in a Pool. StartTaskInformation: properties: state: type: string title: The state of the StartTask on the Compute Node. enum: - running - completed x-ms-enum: name: StartTaskState modelAsString: false values: - value: running description: The StartTask is currently running. - value: completed description: The StartTask has exited with exit code 0, or the StartTask has failed and the retry limit has reached, or the StartTask process did not run due to Task preparation errors (such as resource file download failures). startTime: type: string format: date-time title: The time at which the StartTask started running. description: This value is reset every time the Task is restarted or retried (that is, this is the most recent time at which the StartTask started running). endTime: type: string format: date-time title: The time at which the StartTask stopped running. description: This is the end time of the most recent run of the StartTask, if that run has completed (even if that run failed and a retry is pending). This element is not present if the StartTask is currently running. exitCode: type: integer format: int32 title: The exit code of the program specified on the StartTask command line. description: This property is set only if the StartTask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the StartTask (due to timeout, or user termination via the API) you may see an operating system-defined exit code. containerInfo: $ref: '#/definitions/TaskContainerExecutionInformation' title: Information about the container under which the Task is executing. description: This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/TaskFailureInformation' title: Information describing the Task failure, if any. description: This property is set only if the Task is in the completed state and encountered a failure. retryCount: type: integer format: int32 title: The number of times the Task has been retried by the Batch service. description: Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. lastRetryTime: type: string format: date-time title: The most recent time at which a retry of the Task started running. description: This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. result: $ref: '#/definitions/TaskExecutionResult' title: The result of the Task execution. description: If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - state - startTime - retryCount title: Information about a StartTask running on a Compute Node. StartTask: properties: commandLine: type: string title: The command line of the StartTask. description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/TaskContainerSettings' title: The settings for the container under which the StartTask runs. description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array items: $ref: '#/definitions/ResourceFile' title: A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. description: Files listed under this element are located in the Task's working directory. environmentSettings: type: array items: $ref: '#/definitions/EnvironmentSetting' title: A list of environment variable settings for the StartTask. userIdentity: $ref: '#/definitions/UserIdentity' title: The user identity under which the StartTask runs. description: If omitted, the Task runs as a non-administrative user unique to the Task. maxTaskRetryCount: type: integer format: int32 title: The maximum number of times the Task may be retried. description: The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit. waitForSuccess: type: boolean title: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. description: If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. required: - commandLine title: A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged. description: Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask. NodeReimageParameter: properties: nodeReimageOption: type: string title: When to reimage the Compute Node and what to do with currently running Tasks. description: The default value is requeue. enum: - requeue - terminate - taskcompletion - retaineddata x-ms-enum: name: ComputeNodeReimageOption modelAsString: false values: - value: requeue description: Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Reimage the Compute Node as soon as Tasks have been terminated. - value: terminate description: Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Reimage the Compute Node as soon as Tasks have been terminated. - value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Reimage the Compute Node when all Tasks have completed. name: taskCompletion - value: retaineddata description: Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Reimage the Compute Node when all Task retention periods have expired. name: retainedData title: Options for reimaging a Compute Node. ComputeNodeEndpointConfiguration: properties: inboundEndpoints: type: array items: $ref: '#/definitions/InboundEndpoint' title: The list of inbound endpoints that are accessible on the Compute Node. required: - inboundEndpoints title: The endpoint configuration for the Compute Node. TaskFailureInformation: properties: category: title: The category of the Task error. $ref: '#/definitions/ErrorCategory' code: type: string title: An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. message: type: string title: A message describing the Task error, intended to be suitable for display in a user interface. details: type: array items: $ref: '#/definitions/NameValuePair' title: A list of additional details related to the error. required: - category title: Information about a Task failure. TaskInformation: properties: taskUrl: type: string title: The URL of the Task. jobId: type: string title: The ID of the Job to which the Task belongs. taskId: type: string title: The ID of the Task. subtaskId: type: integer format: int32 title: The ID of the subtask if the Task is a multi-instance Task. taskState: title: The current state of the Task. $ref: '#/definitions/TaskState' executionInfo: $ref: '#/definitions/TaskExecutionInformation' title: Information about the execution of the Task. required: - taskState title: Information about a Task running on a Compute Node. ErrorMessage_2: type: object properties: lang: type: string title: The language code of the error message value: type: string title: The text of the message. title: An error message received in an Azure Batch error response. NodeRebootParameter: properties: nodeRebootOption: type: string title: When to reboot the Compute Node and what to do with currently running Tasks. description: The default value is requeue. enum: - requeue - terminate - taskcompletion - retaineddata x-ms-enum: name: ComputeNodeRebootOption modelAsString: false values: - value: requeue description: Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Restart the Compute Node as soon as Tasks have been terminated. - value: terminate description: Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Restart the Compute Node as soon as Tasks have been terminated. - value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Restart the Compute Node when all Tasks have completed. name: taskCompletion - value: retaineddata description: Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Restart the Compute Node when all Task retention periods have expired. name: retainedData title: Options for rebooting a Compute Node. TaskState: type: string title: The state of the Task. enum: - active - preparing - running - completed x-ms-enum: name: TaskState modelAsString: false values: - value: active description: The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run. - value: preparing description: The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node. - value: running description: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing. - value: completed description: The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated. TaskExecutionResult: type: string title: The result of Task execution. enum: - success - failure x-ms-enum: name: TaskExecutionResult modelAsString: false values: - value: success description: The Task ran successfully. name: success - value: failure description: There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited. name: failure ResourceFile: properties: autoStorageContainerName: type: string title: The storage container name in the auto storage Account. description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. storageContainerUrl: type: string title: The URL of the blob container within Azure Blob Storage. description: 'The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, or set the ACL for the container to allow public access.' httpUrl: type: string title: The URL of the file to download. description: 'The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.' blobPrefix: type: string title: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. filePath: type: string title: The location on the Compute Node to which to download the file(s), relative to the Task's working directory. description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..'). fileMode: type: string title: The file permission mode attribute in octal format. description: This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file. title: A single file or multiple files to be downloaded to a Compute Node. TaskContainerExecutionInformation: properties: containerId: type: string title: The ID of the container. state: type: string title: The state of the container. description: This is the state of the container according to the Docker service. It is equivalent to the status field returned by "docker inspect". error: type: string title: Detailed error information about the container. description: This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by "docker inspect". title: Contains information about the container which a Task is executing. VMExtension: type: object properties: name: type: string title: The name of the virtual machine extension. publisher: type: string title: The name of the extension handler publisher. type: type: string title: The type of the extension. typeHandlerVersion: type: string title: The version of script handler. autoUpgradeMinorVersion: type: boolean description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. enableAutomaticUpgrade: type: boolean description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. settings: type: object title: JSON formatted public settings for the extension. protectedSettings: x-ms-secret: true type: object description: 'The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ' provisionAfterExtensions: type: array items: type: string title: The collection of extension names. description: Collection of extension names after which this extension needs to be provisioned. required: - name - publisher - type title: The configuration for virtual machine extensions. ComputeNode: properties: id: type: string title: The ID of the Compute Node. description: Every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes. url: type: string title: The URL of the Compute Node. state: type: string title: The current state of the Compute Node. description: The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available. enum: - idle - rebooting - reimaging - running - unusable - creating - starting - waitingforstarttask - starttaskfailed - unknown - leavingpool - offline - preempted x-ms-enum: name: ComputeNodeState modelAsString: false values: - value: idle description: The Compute Node is not currently running a Task. - value: rebooting description: The Compute Node is rebooting. - value: reimaging description: The Compute Node is reimaging. - value: running description: The Compute Node is running one or more Tasks (other than a StartTask). - value: unusable description: The Compute Node cannot be used for Task execution due to errors. - value: creating description: The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the Pool. - value: starting description: The Batch service is starting on the underlying virtual machine. - value: waitingforstarttask description: The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed. name: waitingForStartTask - value: starttaskfailed description: The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess is set. The Compute Node is not usable for running Tasks. name: startTaskFailed - value: unknown description: The Batch service has lost contact with the Compute Node, and does not know its true state. - value: leavingpool description: The Compute Node is leaving the Pool, either because the user explicitly removed it or because the Pool is resizing or autoscaling down. name: leavingPool - value: offline description: The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled. - value: preempted description: The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available. schedulingState: type: string title: Whether the Compute Node is available for Task scheduling. enum: - enabled - disabled x-ms-enum: name: SchedulingState modelAsString: false values: - value: enabled description: Tasks can be scheduled on the Compute Node. - value: disabled description: No new Tasks will be scheduled on the Compute Node. Tasks already running on the Compute Node may still run to completion. All Compute Nodes start with scheduling enabled. stateTransitionTime: type: string format: date-time title: The time at which the Compute Node entered its current state. lastBootTime: type: string format: date-time title: The last time at which the Compute Node was started. description: This property may not be present if the Compute Node state is unusable. allocationTime: type: string format: date-time title: The time at which this Compute Node was allocated to the Pool. description: This is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted. ipAddress: type: string title: The IP address that other Nodes can use to communicate with this Compute Node. description: Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes. affinityId: type: string title: An identifier which can be passed when adding a Task to request that the Task be scheduled on this Compute Node. description: Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere. vmSize: type: string title: The size of the virtual machine hosting the Compute Node. description: For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). totalTasksRun: type: integer format: int32 title: The total number of Job Tasks completed on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. runningTasksCount: type: integer format: int32 title: The total number of currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. runningTaskSlotsCount: type: integer format: int32 title: The total number of scheduling slots used by currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. totalTasksSucceeded: type: integer format: int32 title: The total number of Job Tasks which completed successfully (with exitCode 0) on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. recentTasks: type: array items: $ref: '#/definitions/TaskInformation' title: A list of Tasks whose state has recently changed. description: This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool. startTask: $ref: '#/definitions/StartTask' title: The Task specified to run on the Compute Node as it joins the Pool. startTaskInfo: $ref: '#/definitions/StartTaskInformation' title: Runtime information about the execution of the StartTask on the Compute Node. certificateReferences: type: array items: $ref: '#/definitions/CertificateReference' title: The list of Certificates installed on the Compute Node. description: For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory. errors: type: array items: $ref: '#/definitions/ComputeNodeError' title: The list of errors that are currently being encountered by the Compute Node. isDedicated: type: boolean title: Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a low-priority Compute Node. endpointConfiguration: $ref: '#/definitions/ComputeNodeEndpointConfiguration' title: The endpoint configuration for the Compute Node. nodeAgentInfo: $ref: '#/definitions/NodeAgentInformation' title: Information about the Compute Node agent version and the time the Compute Node upgraded to a new version. title: A Compute Node in the Batch service. ErrorCategory: type: string title: The category of the error. enum: - usererror - servererror x-ms-enum: name: ErrorCategory modelAsString: false values: - value: usererror description: The error is due to a user issue, such as misconfiguration. name: userError - value: servererror description: The error is due to an internal server issue. name: serverError UploadBatchServiceLogsConfiguration: properties: containerUrl: type: string title: The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). description: The URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified. startTime: type: string format: date-time title: The start of the time range from which to upload Batch Service log file(s). description: Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. endTime: type: string format: date-time title: The end of the time range from which to upload Batch Service log file(s). description: Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime. required: - containerUrl - startTime title: The Azure Batch service log files upload configuration for a Compute Node. NodeVMExtensionList: type: object properties: value: type: array items: $ref: '#/definitions/NodeVMExtension' title: The list of Compute Node extensions. odata.nextLink: type: string title: The URL to get the next set of results. title: The result of listing the Compute Node extensions in a Node. NodeDisableSchedulingParameter: properties: nodeDisableSchedulingOption: type: string title: What to do with currently running Tasks when disabling Task scheduling on the Compute Node. description: The default value is requeue. enum: - requeue - terminate - taskcompletion x-ms-enum: name: DisableComputeNodeSchedulingOption modelAsString: false values: - value: requeue description: Terminate running Task processes and requeue the Tasks. The Tasks may run again on other Compute Nodes, or when Task scheduling is re-enabled on this Compute Node. Enter offline state as soon as Tasks have been terminated. - value: terminate description: Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as Tasks have been terminated. - value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Enter offline state when all Tasks have completed. name: taskCompletion title: Options for disabling scheduling on a Compute Node. InboundEndpointProtocol: type: string title: The protocol of the endpoint. enum: - tcp - udp x-ms-enum: name: InboundEndpointProtocol modelAsString: false values: - value: tcp description: Use TCP for the endpoint. name: tcp - value: udp description: Use UDP for the endpoint. name: udp NameValuePair: properties: name: type: string title: The name in the name-value pair. value: type: string title: The value in the name-value pair. title: Represents a name-value pair. ComputeNodeError: properties: code: type: string title: An identifier for the Compute Node error. Codes are invariant and are intended to be consumed programmatically. message: type: string title: A message describing the Compute Node error, intended to be suitable for display in a user interface. errorDetails: type: array items: $ref: '#/definitions/NameValuePair' title: The list of additional error details related to the Compute Node error. title: An error encountered by a Compute Node. NodeAgentInformation: properties: version: type: string title: The version of the Batch Compute Node agent running on the Compute Node. description: This version number can be checked against the Compute Node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. lastUpdateTime: type: string format: date-time title: The time when the Compute Node agent was updated on the Compute Node. description: This is the most recent time that the Compute Node agent was updated to a new version. required: - version - lastUpdateTime title: Information about the Compute Node agent. description: The Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node. VMExtensionInstanceView: type: object properties: name: type: string title: The name of the vm extension instance view. statuses: type: array items: $ref: '#/definitions/InstanceViewStatus' description: The resource status information. subStatuses: type: array items: $ref: '#/definitions/InstanceViewStatus' description: The resource status information. title: The vm extension instance view. TaskExecutionInformation: properties: startTime: type: string format: date-time title: The time at which the Task started running. description: '''Running'' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present only for Tasks that are in the running or completed state.' endTime: type: string format: date-time title: The time at which the Task completed. description: This property is set only if the Task is in the Completed state. exitCode: type: integer format: int32 title: The exit code of the program specified on the Task command line. description: This property is set only if the Task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code. containerInfo: $ref: '#/definitions/TaskContainerExecutionInformation' title: Information about the container under which the Task is executing. description: This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/TaskFailureInformation' title: Information describing the Task failure, if any. description: This property is set only if the Task is in the completed state and encountered a failure. retryCount: type: integer format: int32 title: The number of times the Task has been retried by the Batch service. description: Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. lastRetryTime: type: string format: date-time title: The most recent time at which a retry of the Task started running. description: This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. requeueCount: type: integer format: int32 title: The number of times the Task has been requeued by the Batch service as the result of a user request. description: When the user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons. lastRequeueTime: type: string format: date-time title: The most recent time at which the Task has been requeued by the Batch service as the result of a user request. description: This property is set only if the requeueCount is nonzero. result: $ref: '#/definitions/TaskExecutionResult' title: The result of the Task execution. description: If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - requeueCount - retryCount title: Information about the execution of a Task. BatchErrorDetail: properties: key: type: string title: An identifier specifying the meaning of the Value property. value: type: string title: The additional information included with the error response. title: An item of additional information included in an Azure Batch error response. parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Client API Version. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'