{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector ComputeNodes API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "ComputeNodes", "type": "folder" }, "items": [ { "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-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool from which you want to remove Compute Nodes." }, { "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": "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 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": "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." }, { "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": "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": "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." }, { "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": "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": "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." }, { "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": "You can delete a user Account to a Compute Node only when it is in the idle or running state." }, { "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": "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." }, { "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": "Needs a more full description created." }, { "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": "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." }, { "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": "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": "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." }, { "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": "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 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": "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." }, { "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": "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": "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." }, { "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": "You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled" }, { "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": "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." }, { "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": "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 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": "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 Protocol file." }, { "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": "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 Upload Azure Batch Service Log Files From The Specified Compute Node To Azure Blob 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": "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 from which you want to upload the Azure Batch service log files." }, { "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": "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 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": "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 https://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." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000 Compute Nodes can 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": "Needs a more full description created." }, { "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": "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 of the Compute Node Extension that you want to get information about." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "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": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Needs a more full description created." }, { "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": "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." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000 Compute Nodes can 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. If the value is larger than 30, the default will be used instead." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Needs a more full description created." } ] } ], "bundled": true }