{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Pools API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Pools", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Lists All Of The Pools In The Specified Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "$expand", "value": "", "type": "query", "description": "An OData $expand clause." } ] }, "docs": "Lists all of the Pools in the specified Account." }, { "info": { "name": "Microsoft Azure Creates A Pool To The Specified Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." } ] }, "docs": "When naming Pools, avoid including sensitive information such as user names or
secret project names. This information may appear in telemetry logs accessible
to Microsoft Support engineers." }, { "info": { "name": "Microsoft Azure Get Pools Poolid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool to get." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "$expand", "value": "", "type": "query", "description": "An OData $expand clause." } ] }, "docs": "Gets information about the specified Pool." }, { "info": { "name": "Microsoft Azure Updates The Properties Of The Specified Pool", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/pools/:poolId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool to get." } ] }, "docs": "This only replaces the Pool properties specified in the request. For example,
if the Pool has a StartTask associated with it, and a request does not specify
a StartTask element, then the Pool keeps the existing StartTask." }, { "info": { "name": "Microsoft Azure Deletes A Pool From The Specified Account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/pools/:poolId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool to get." } ] }, "docs": "When you request that a Pool be deleted, the following actions occur: the Pool
state is set to deleting; any ongoing resize operation on the Pool are stopped;
the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks
running on existing Compute Nodes are terminated and requeued (as if a resize
Pool operation had been requested with the default requeue option); finally,
the Pool is removed from the system. Because running Tasks are requeued, the
user can rerun " }, { "info": { "name": "Microsoft Azure Head Pools Poolid", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/pools/:poolId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool to get." } ] }, "docs": "Gets basic properties of a Pool." }, { "info": { "name": "Microsoft Azure Disables Automatic Scaling For A Pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/disableautoscale", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool on which to disable automatic scaling." } ] }, "docs": "Disables automatic scaling for a Pool." }, { "info": { "name": "Microsoft Azure Enables Automatic Scaling For A Pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/enableautoscale", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool to get." } ] }, "docs": "You cannot enable automatic scaling on a Pool if a resize operation is in
progress on the Pool. If automatic scaling of the Pool is currently disabled,
you must specify a valid autoscale formula as part of the request. If automatic
scaling of the Pool is already enabled, you may specify a new autoscale formula
and/or a new evaluation interval. You cannot call this API for the same Pool
more than once every 30 seconds." }, { "info": { "name": "Microsoft Azure Gets The Result Of Evaluating An Automatic Scaling Formula On The Pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/evaluateautoscale", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool on which to evaluate the automatic scaling formula." } ] }, "docs": "This API is primarily for validating an autoscale formula, as it simply returns
the result without applying the formula to the Pool. The Pool must have auto
scaling enabled in order to evaluate a formula." }, { "info": { "name": "Microsoft Azure Lists The Compute Nodes In The Specified Pool", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool from which you want to list Compute Nodes." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." } ] }, "docs": "Lists the Compute Nodes in the specified Pool." }, { "info": { "name": "Microsoft Azure Gets Information About The Specified Compute Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node that you want to get information about." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." } ] }, "docs": "Gets information about the specified Compute Node." }, { "info": { "name": "Microsoft Azure Disables Task Scheduling On The Specified Compute Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/disablescheduling", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node on which you want to disable Task scheduling." } ] }, "docs": "You can disable Task scheduling on a Compute Node only if its current
scheduling state is enabled." }, { "info": { "name": "Microsoft Azure Enables Task Scheduling On The Specified Compute Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/enablescheduling", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node on which you want to enable Task scheduling." } ] }, "docs": "You can enable Task scheduling on a Compute Node only if its current scheduling
state is disabled" }, { "info": { "name": "Microsoft Azure Lists The Compute Nodes Extensions In The Specified Pool", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/extensions", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node that you want to list extensions." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." } ] }, "docs": "Lists the Compute Nodes Extensions in the specified Pool." }, { "info": { "name": "Microsoft Azure Gets Information About The Specified Compute Node Extension", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/extensions/:extensionName", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node that contains the extensions." }, { "name": "extensionName", "value": "", "type": "path", "description": "The name of the Compute Node Extension that you want to get information about." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." } ] }, "docs": "Gets information about the specified Compute Node Extension." }, { "info": { "name": "Microsoft Azure Lists All Of The Files In Task Directories On The Specified Compute Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/files", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node whose files you want to list." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files." }, { "name": "recursive", "value": "", "type": "query", "description": "Whether to list children of a directory." } ] }, "docs": "Lists all of the files in Task directories on the specified Compute Node." }, { "info": { "name": "Microsoft Azure Get Pools Poolid Nodes Nodeid Files Filepath", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "ocp-range", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the file or directory." } ] }, "docs": "Returns the content of the specified Compute Node file." }, { "info": { "name": "Microsoft Azure Deletes The Specified File From The Compute Node", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the file or directory." }, { "name": "recursive", "value": "", "type": "query", "description": "Whether to delete children of a directory. If the filePath parameter represents\na directory instead of a file, you can set recursive to true to delete the\ndirectory and all of the files and subdirectories in it. If recursive is false\nthen the directory must be empty or deletion will fail." } ] }, "docs": "Deletes the specified file from the Compute Node." }, { "info": { "name": "Microsoft Azure Head Pools Poolid Nodes Nodeid Files Filepath", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the file or directory." } ] }, "docs": "Gets the properties of the specified Compute Node file." }, { "info": { "name": "Microsoft Azure Gets The Remote Desktop Protocol File For The Specified Compute Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/rdp", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node for which you want to get the Remote Desktop\nProtocol file." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Restarts The Specified Compute Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/reboot", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node that you want to restart." } ] }, "docs": "You can restart a Compute Node only if it is in an idle or running state." }, { "info": { "name": "Microsoft Azure Reinstalls The Operating System On The Specified Compute Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/reimage", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node that you want to restart." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Gets The Settings Required For Remote Login To A Compute Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/remoteloginsettings", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node for which to obtain the remote login settings." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Upload Azure Batch Service Log Files From The Specified Compute Node To Azure\nblob Storage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/uploadbatchservicelogs", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node for which you want to get the Remote Desktop\nProtocol file." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Adds A User Account To The Specified Compute Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/users", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the machine on which you want to create a user Account." } ] }, "docs": "You can add a user Account to a Compute Node only when it is in the idle or
running state." }, { "info": { "name": "Microsoft Azure Updates The Password And Expiration Time Of A User Account On The Specified Compute Node", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/users/:userName", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the machine on which you want to update a user Account." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user Account to update." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Deletes A User Account From The Specified Compute Node", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/users/:userName", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the machine on which you want to delete a user Account." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user Account to delete." } ] }, "docs": "You can delete a user Account to a Compute Node only when it is in the idle or
running state." }, { "info": { "name": "Microsoft Azure Removes Compute Nodes From The Specified Pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/removenodes", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool to get." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Changes The Number Of Compute Nodes That Are Assigned To A Pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/resize", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool to get." } ] }, "docs": "You can only resize a Pool when its allocation state is steady. If the Pool is
already resizing, the request fails with status code 409. When you resize a
Pool, the Pool's allocation state changes from steady to resizing. You cannot
resize Pools which are configured for automatic scaling. If you try to do this,
the Batch service returns an error 409. If you resize a Pool downwards, the
Batch service chooses which Compute Nodes to remove. To remove specific Compute
Nodes, use th" }, { "info": { "name": "Microsoft Azure Stops An Ongoing Resize Operation On The Pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/stopresize", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool to get." } ] }, "docs": "This does not restore the Pool to its previous state before the resize
operation: it only stops any further changes being made, and the Pool maintains
its current state. After stopping, the Pool stabilizes at the number of Compute
Nodes it was at when the stop operation was done. During the stop operation,
the Pool allocation state changes first to stopping and then to steady. A
resize operation need not be an explicit resize Pool request; this API can also
be used to halt the " }, { "info": { "name": "Microsoft Azure Updates The Properties Of The Specified Pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pools/:poolId/updateproperties", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "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.\"." }, { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool to update." } ] }, "docs": "This fully replaces all the updatable properties of the Pool. For example, if
the Pool has a StartTask associated with it and if StartTask is not specified
with this request, then the Batch service will remove the existing StartTask." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Containerstorage Pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.ContainerStorage/pools" }, "docs": "List Pool resources by subscription ID" }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ContainerStorage/pools" }, "docs": "List Pool resources by resource group" }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ContainerStorage/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Pool Object" } ] }, "docs": "Get a Pool" }, { "info": { "name": "Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ContainerStorage/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Pool Object" } ] }, "docs": "Create a Pool" }, { "info": { "name": "Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ContainerStorage/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Pool Object" } ] }, "docs": "Update a Pool" }, { "info": { "name": "Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ContainerStorage/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Pool Object" } ] }, "docs": "Delete a Pool" }, { "info": { "name": "Microsoft Azure Lists The Usage Metrics, Aggregated By Pool Across Individual Time Intervals, For The Specified Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/poolusagemetrics", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "starttime", "value": "", "type": "query", "description": "The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available." }, { "name": "endtime", "value": "", "type": "query", "description": "The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available." }, { "name": "$filter", "value": "", "type": "query", "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-account-usage-metrics." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000 results will be returned." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "If you do not specify a $filter clause including a poolId, the response includes all Pools that existed in the Account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned." }, { "info": { "name": "Microsoft Azure Gets Lifetime Summary Statistics For All Of The Pools In The Specified Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lifetimepoolstats", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Statistics are aggregated across all Pools that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevCenter/projects/:projectName/pools" }, "docs": "Lists pools for a project" }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevCenter/projects/:projectName/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Name of the pool." } ] }, "docs": "Gets a machine pool" }, { "info": { "name": "Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevCenter/projects/:projectName/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Name of the pool." } ] }, "docs": "Creates or updates a machine pool" }, { "info": { "name": "Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevCenter/projects/:projectName/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Name of the pool." } ] }, "docs": "Partially updates a machine pool" }, { "info": { "name": "Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevCenter/projects/:projectName/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Name of the pool." } ] }, "docs": "Deletes a machine pool" }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Devopsinfrastructure Pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.DevOpsInfrastructure/pools" }, "docs": "List Pool resources by subscription ID" }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevOpsInfrastructure/pools" }, "docs": "List Pool resources by resource group" }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevOpsInfrastructure/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Name of the pool. It needs to be globally unique." } ] }, "docs": "Get a Pool" }, { "info": { "name": "Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevOpsInfrastructure/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Name of the pool. It needs to be globally unique." } ] }, "docs": "Create a Pool" }, { "info": { "name": "Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevOpsInfrastructure/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Name of the pool. It needs to be globally unique." } ] }, "docs": "Update a Pool" }, { "info": { "name": "Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DevOpsInfrastructure/pools/:poolName", "params": [ { "name": "poolName", "value": "", "type": "path", "description": "Name of the pool. It needs to be globally unique." } ] }, "docs": "Delete a Pool" } ] } ], "bundled": true }