Skip to main content

pool_exists

Creates, updates, deletes, gets or lists a pool_exists resource.

Overview

Namepool_exists
TypeResource
Idazure.batch_dataplane.pool_exists

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
pool_existsexecpool_id, endpointtimeOut, ocp-date, If-Modified-Since, If-Unmodified-SinceGets basic properties of a Pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
endpointstringThe service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
pool_idstringThe ID of the Pool to get. Required.
If-Modified-SincestringA 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. Default value is None.
If-Unmodified-SincestringA 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. Default value is None.
ocp-datestringThe 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. Default value is None.
timeOutintegerThe 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.". Default value is None.

Lifecycle Methods

Gets basic properties of a Pool.

EXEC azure.batch_dataplane.pool_exists.pool_exists 
@pool_id='{{ pool_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeOut='{{ timeOut }}',
@ocp-date='{{ ocp-date }}',
@If-Modified-Since='{{ If-Modified-Since }}',
@If-Unmodified-Since='{{ If-Unmodified-Since }}'
;