node_types

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

Overview

Name	node_types
Type	Resource
Id	azure.service_fabric_managed_clusters.node_types

Fields

The following fields are returned by SELECT queries:

get

The operation completed successfully.

Name	Datatype	Description
id	string	Azure resource identifier.
name	string	Azure resource name.
properties	object	The node type properties
sku	object	The node type sku.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Azure resource tags.
type	string	Azure resource type.

list_by_managed_clusters

The operation completed successfully.

Name	Datatype	Description
id	string	Azure resource identifier.
name	string	Azure resource name.
properties	object	The node type properties
sku	object	The node type sku.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Azure resource tags.
type	string	Azure resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, nodeTypeName	api-version	Get a Service Fabric node type of a given managed cluster.
list_by_managed_clusters	select	resourceGroupName, subscriptionId, clusterName	api-version	Gets all Node types of the specified managed cluster.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, nodeTypeName	api-version	Create or update a Service Fabric node type of a given managed cluster.
update	update	subscriptionId, resourceGroupName, clusterName, nodeTypeName	api-version	Update the configuration of a node type of a given managed cluster, only updating tags.
delete	delete	subscriptionId, resourceGroupName, clusterName, nodeTypeName	api-version	Delete a Service Fabric node type of a given managed cluster.
restart	exec	subscriptionId, resourceGroupName, clusterName, nodeTypeName	api-version	Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.
reimage	exec	subscriptionId, resourceGroupName, clusterName, nodeTypeName	api-version	Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.

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
clusterName	string	The name of the cluster resource.
nodeTypeName	string	The name of the node type.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The customer subscription identifier.
api-version	string	The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2024-06-01-preview" for this specification.

SELECT examples

get

Get a Service Fabric node type of a given managed cluster.

SELECT
id,
name,
properties,
sku,
systemData,
tags,
type
FROM azure.service_fabric_managed_clusters.node_types
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND nodeTypeName = '{{ nodeTypeName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_managed_clusters

Gets all Node types of the specified managed cluster.

SELECT
id,
name,
properties,
sku,
systemData,
tags,
type
FROM azure.service_fabric_managed_clusters.node_types
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Create or update a Service Fabric node type of a given managed cluster.

INSERT INTO azure.service_fabric_managed_clusters.node_types (
data__tags,
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
clusterName,
nodeTypeName,
api-version
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ nodeTypeName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: node_types
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the node_types resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the node_types resource.
    - name: clusterName
      value: string
      description: Required parameter for the node_types resource.
    - name: nodeTypeName
      value: string
      description: Required parameter for the node_types resource.
    - name: tags
      value: object
      description: |
        Azure resource tags.
    - name: properties
      value: object
      description: |
        The node type properties
    - name: sku
      value: object
      description: |
        The node type sku.
    - name: api-version
      value: string
      description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2024-06-01-preview" for this specification.

UPDATE examples

update

Update the configuration of a node type of a given managed cluster, only updating tags.

UPDATE azure.service_fabric_managed_clusters.node_types
SET 
data__tags = '{{ tags }}',
data__sku = '{{ sku }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND nodeTypeName = '{{ nodeTypeName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete a Service Fabric node type of a given managed cluster.

DELETE FROM azure.service_fabric_managed_clusters.node_types
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND nodeTypeName = '{{ nodeTypeName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

restart

Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.

EXEC azure.service_fabric_managed_clusters.node_types.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@nodeTypeName='{{ nodeTypeName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"nodes": "{{ nodes }}", 
"force": {{ force }}, 
"updateType": "{{ updateType }}"
}'
;

reimage

Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.

EXEC azure.service_fabric_managed_clusters.node_types.reimage 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@nodeTypeName='{{ nodeTypeName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"nodes": "{{ nodes }}", 
"force": {{ force }}, 
"updateType": "{{ updateType }}"
}'
;