node_pools

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

Overview

Name	node_pools
Type	Resource
Id	azure.discovery.node_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
maxNodeCount	integer	The maximum number of nodes. Required.
minNodeCount	integer	The minimum number of nodes.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
scaleSetPriority	string	The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. Known values are: "Regular" and "Spot". (Regular, Spot)
subnetId	string	The node pool subnet. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmSize	string	The size of the underlying Azure VM. Required. Known values are: "Standard_NC24ads_A100_v4", "Standard_NC48ads_A100_v4", "Standard_NC96ads_A100_v4", "Standard_NC4as_T4_v3", "Standard_NC8as_T4_v3", "Standard_NC16as_T4_v3", "Standard_NC64as_T4_v3", "Standard_NV6ads_A10_v5", "Standard_NV12ads_A10_v5", "Standard_NV24ads_A10_v5", "Standard_NV36ads_A10_v5", "Standard_NV36adms_A10_v5", "Standard_NV72ads_A10_v5", and "Standard_ND40rs_v2". (Standard_NC24ads_A100_v4, Standard_NC48ads_A100_v4, Standard_NC96ads_A100_v4, Standard_NC4as_T4_v3, Standard_NC8as_T4_v3, Standard_NC16as_T4_v3, Standard_NC64as_T4_v3, Standard_NV6ads_A10_v5, Standard_NV12ads_A10_v5, Standard_NV24ads_A10_v5, Standard_NV36ads_A10_v5, Standard_NV36adms_A10_v5, Standard_NV72ads_A10_v5, Standard_ND40rs_v2)

list_by_supercomputer

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
maxNodeCount	integer	The maximum number of nodes. Required.
minNodeCount	integer	The minimum number of nodes.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
scaleSetPriority	string	The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. Known values are: "Regular" and "Spot". (Regular, Spot)
subnetId	string	The node pool subnet. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmSize	string	The size of the underlying Azure VM. Required. Known values are: "Standard_NC24ads_A100_v4", "Standard_NC48ads_A100_v4", "Standard_NC96ads_A100_v4", "Standard_NC4as_T4_v3", "Standard_NC8as_T4_v3", "Standard_NC16as_T4_v3", "Standard_NC64as_T4_v3", "Standard_NV6ads_A10_v5", "Standard_NV12ads_A10_v5", "Standard_NV24ads_A10_v5", "Standard_NV36ads_A10_v5", "Standard_NV36adms_A10_v5", "Standard_NV72ads_A10_v5", and "Standard_ND40rs_v2". (Standard_NC24ads_A100_v4, Standard_NC48ads_A100_v4, Standard_NC96ads_A100_v4, Standard_NC4as_T4_v3, Standard_NC8as_T4_v3, Standard_NC16as_T4_v3, Standard_NC64as_T4_v3, Standard_NV6ads_A10_v5, Standard_NV12ads_A10_v5, Standard_NV24ads_A10_v5, Standard_NV36ads_A10_v5, Standard_NV36adms_A10_v5, Standard_NV72ads_A10_v5, Standard_ND40rs_v2)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, supercomputer_name, node_pool_name, subscription_id		Get a NodePool.
list_by_supercomputer	select	resource_group_name, supercomputer_name, subscription_id		List NodePool resources by Supercomputer.
create_or_update	insert	resource_group_name, supercomputer_name, node_pool_name, subscription_id, location		Create a NodePool.
update	update	resource_group_name, supercomputer_name, node_pool_name, subscription_id, location		Update a NodePool.
create_or_update	replace	resource_group_name, supercomputer_name, node_pool_name, subscription_id, location		Create a NodePool.
delete	delete	resource_group_name, supercomputer_name, node_pool_name, subscription_id		Delete a NodePool.

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
node_pool_name	string	The name of the NodePool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
supercomputer_name	string	The name of the Supercomputer. Required.

SELECT examples

get

Get a NodePool.

SELECT
id,
name,
location,
maxNodeCount,
minNodeCount,
provisioningState,
scaleSetPriority,
subnetId,
systemData,
tags,
type,
vmSize
FROM azure.discovery.node_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND supercomputer_name = '{{ supercomputer_name }}' -- required
AND node_pool_name = '{{ node_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_supercomputer

List NodePool resources by Supercomputer.

SELECT
id,
name,
location,
maxNodeCount,
minNodeCount,
provisioningState,
scaleSetPriority,
subnetId,
systemData,
tags,
type,
vmSize
FROM azure.discovery.node_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND supercomputer_name = '{{ supercomputer_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a NodePool.

INSERT INTO azure.discovery.node_pools (
tags,
location,
properties,
resource_group_name,
supercomputer_name,
node_pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ supercomputer_name }}',
'{{ node_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: node_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the node_pools resource.
  - name: supercomputer_name
    value: "{{ supercomputer_name }}"
    description: Required parameter for the node_pools resource.
  - name: node_pool_name
    value: "{{ node_pool_name }}"
    description: Required parameter for the node_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the node_pools resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      subnetId: "{{ subnetId }}"
      vmSize: "{{ vmSize }}"
      maxNodeCount: {{ maxNodeCount }}
      minNodeCount: {{ minNodeCount }}
      scaleSetPriority: "{{ scaleSetPriority }}"

UPDATE examples

update

Update a NodePool.

UPDATE azure.discovery.node_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND supercomputer_name = '{{ supercomputer_name }}' --required
AND node_pool_name = '{{ node_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a NodePool.

REPLACE azure.discovery.node_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND supercomputer_name = '{{ supercomputer_name }}' --required
AND node_pool_name = '{{ node_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a NodePool.

DELETE FROM azure.discovery.node_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND supercomputer_name = '{{ supercomputer_name }}' --required
AND node_pool_name = '{{ node_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;