node_extensions

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

Overview

Name	node_extensions
Type	Resource
Id	azure.batch_dataplane.node_extensions

Fields

The following fields are returned by SELECT queries:

get_node_extension

Name	Datatype	Description
instanceView	object	The vm extension instance view.
provisioningState	string	The provisioning state of the virtual machine extension.
vmExtension	object	The configuration for virtual machine extensions.

list_node_extensions

Name	Datatype	Description
instanceView	object	The vm extension instance view.
provisioningState	string	The provisioning state of the virtual machine extension.
vmExtension	object	The configuration for virtual machine extensions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_node_extension	select	pool_id, node_id, extension_name, endpoint	timeOut, ocp-date, $select	Gets information about the specified Compute Node Extension. Gets information about the specified Compute Node Extension.
list_node_extensions	select	pool_id, node_id, endpoint	timeOut, ocp-date, maxresults, $select	Lists the Compute Nodes Extensions in the specified Pool. Lists the Compute Nodes Extensions in the specified 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.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
extension_name	string	The name of the Compute Node Extension that you want to get information about. Required.
node_id	string	The ID of the Compute Node that you want to list extensions. Required.
pool_id	string	The ID of the Pool that contains Compute Node. Required.
$select	array	An OData $select clause. Default value is None.
maxresults	integer	The maximum number of items to return in the response. A maximum of 1000 applications can be returned. Default value is None.
ocp-date	string	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. Default value is None.
timeOut	integer	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.". Default value is None.

SELECT examples

get_node_extension

Gets information about the specified Compute Node Extension. Gets information about the specified Compute Node Extension.

SELECT
instanceView,
provisioningState,
vmExtension
FROM azure.batch_dataplane.node_extensions
WHERE pool_id = '{{ pool_id }}' -- required
AND node_id = '{{ node_id }}' -- required
AND extension_name = '{{ extension_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeOut = '{{ timeOut }}'
AND ocp-date = '{{ ocp-date }}'
AND $select = '{{ $select }}'
;

list_node_extensions

Lists the Compute Nodes Extensions in the specified Pool. Lists the Compute Nodes Extensions in the specified Pool.

SELECT
instanceView,
provisioningState,
vmExtension
FROM azure.batch_dataplane.node_extensions
WHERE pool_id = '{{ pool_id }}' -- required
AND node_id = '{{ node_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeOut = '{{ timeOut }}'
AND ocp-date = '{{ ocp-date }}'
AND maxresults = '{{ maxresults }}'
AND $select = '{{ $select }}'
;