az sf managed-node-type

Manage a node type of an Azure Service Fabric managed cluster.

Commands

Name	Description	Type	Status
az sf managed-node-type create	Create node type on a managed cluster.	Core	GA
az sf managed-node-type delete	Delete node type from a cluster.	Core	GA
az sf managed-node-type list	List node types of a managed cluster.	Core	GA
az sf managed-node-type node	Perform operations on nodes of a node type on managed clusters.	Core	GA
az sf managed-node-type node delete	Delete nodes of a node type.	Core	GA
az sf managed-node-type node reimage	Reimage nodes of a node type.	Core	GA
az sf managed-node-type node restart	Restart nodes of a node type.	Core	GA
az sf managed-node-type show	Show the properties of a node type.	Core	GA
az sf managed-node-type update	Update node type on a managed cluster.	Core	GA
az sf managed-node-type vm-extension	Managed vm extension on a node type on managed clusters.	Core	GA
az sf managed-node-type vm-extension add	Add an extension to the node type.	Core	GA
az sf managed-node-type vm-extension delete	Delete an extension to the node type.	Core	GA
az sf managed-node-type vm-secret	Managed vm secrets on a node type on managed clusters.	Core	GA
az sf managed-node-type vm-secret add	Add a secret to the node type.	Core	GA

az sf managed-node-type create

Create node type on a managed cluster.

az sf managed-node-type create --cluster-name
                               --instance-count
                               --name
                               --resource-group
                               [--app-end-port]
                               [--app-start-port]
                               [--capacity]
                               [--data-disk-size]
                               [--data-disk-type {Premium_LRS, StandardSSD_LRS, Standard_LRS}]
                               [--ephemeral-end-port]
                               [--ephemeral-start-port]
                               [--is-stateless {false, true}]
                               [--multi-place-groups {false, true}]
                               [--placement-property]
                               [--primary {false, true}]
                               [--vm-image-offer]
                               [--vm-image-publisher]
                               [--vm-image-sku]
                               [--vm-image-version]
                               [--vm-size]

Examples

Create primary node type with 5 nodes.

az sf managed-node-type create -g testRG -c testCluster -n pnt --instance-count 5 --primary

Create non primary node type with placement properities, capacities and ports.

az sf managed-node-type create -g testRG -c testCluster -n snt --instance-count 5 --placement-property NodeColor=Green SomeProperty=5 --capacity ClientConnections=65536 --app-start-port 20575 --app-end-port 20605 --ephemeral-start-port 20606 --ephemeral-end-port 20861

Required Parameters

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--instance-count

Essage = "The number of nodes in the node type.

--name --node-type-name -n

Node type name.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--app-end-port --application-end-port

Application End port of a range of ports.

--app-start-port --application-start-port

Application start port of a range of ports.

--capacity

Capacity tags applied to the nodes in the node type as key/value pairs, the cluster resource manager uses these tags to understand how much resource a node has. Updating this will override the current values.for example: --capacity ClientConnections=65536 param2=value2.

--data-disk-size --disk-size

Disk size for each vm in the node type in GBs.

default value: 100

--data-disk-type --disk-type

Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/azure/virtual-machines/disks-types. Default StandardSSD_LRSStandard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access.StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test.Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads.

accepted values: Premium_LRS, StandardSSD_LRS, Standard_LRS

--ephemeral-end-port

Ephemeral end port of a range of ports.

--ephemeral-start-port

Ephemeral start port of a range of ports.

--is-stateless

Indicates if the node type can only host Stateless workloads.

accepted values: false, true

default value: False

--multi-place-groups --multiple-placement-groups

Indicates if scale set associated with the node type can be composed of multiple placement groups.

accepted values: false, true

default value: False

--placement-property

Placement tags applied to nodes in the node type as key/value pairs, which can be used to indicate where certain services (workload) should run. Updating this will override the current values.for example: --placement-property NodeColor=Green SomeProperty=5.

--primary

Specify if the node type is primary. On this node type will run system services. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters.

accepted values: false, true

default value: False

--vm-image-offer

The offer type of the Azure Virtual Machines Marketplace image.

default value: WindowsServer

--vm-image-publisher

The publisher of the Azure Virtual Machines Marketplace image.

default value: MicrosoftWindowsServer

--vm-image-sku

The SKU of the Azure Virtual Machines Marketplace image.

default value: 2019-Datacenter

--vm-image-version

The version of the Azure Virtual Machines Marketplace image.

default value: latest

--vm-size

The size of virtual machines in the pool. All virtual machines in a pool are the same size.

default value: Standard_D2

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf managed-node-type delete

Delete node type from a cluster.

az sf managed-node-type delete --cluster-name
                               --name
                               --resource-group

Examples

Delete cluster.

az sf managed-node-type delete -g testRG -c testCluster -n snt

Required Parameters

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--name --node-type-name -n

Node type name.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf managed-node-type list

List node types of a managed cluster.

az sf managed-node-type list --cluster-name
                             --resource-group

Examples

List node types by cluster.

az sf managed-node-type list -g testRG -c testCluster

Required Parameters

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf managed-node-type show

Show the properties of a node type.

az sf managed-node-type show --cluster-name
                             --name
                             --resource-group

Examples

Get node type.

az sf managed-node-type show -g testRG -c testCluster -n pnt

Required Parameters

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--name --node-type-name -n

Node type name.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf managed-node-type update

Update node type on a managed cluster.

az sf managed-node-type update --cluster-name
                               --name
                               --resource-group
                               [--app-end-port]
                               [--app-start-port]
                               [--capacity]
                               [--ephemeral-end-port]
                               [--ephemeral-start-port]
                               [--instance-count]
                               [--placement-property]

Examples

Update the instance count of the node type.

az sf managed-node-type update -g testRG -c testCluster -n snt --instance-count 7

Update placement properties of the node type. This will overwrite older placement properties if any.

az sf managed-node-type update -g testRG -c testCluster -n snt --placement-property NodeColor=Red SomeProperty=6

Required Parameters

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--name --node-type-name -n

Node type name.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--app-end-port --application-end-port

Application End port of a range of ports.

--app-start-port --application-start-port

Application start port of a range of ports.

--capacity

Capacity tags applied to the nodes in the node type as key/value pairs, the cluster resource manager uses these tags to understand how much resource a node has. Updating this will override the current values.for example: --capacity ClientConnections=65536 param2=value2.

--ephemeral-end-port

Ephemeral end port of a range of ports.

--ephemeral-start-port

Ephemeral start port of a range of ports.

--instance-count

Essage = "The number of nodes in the node type.

--placement-property

Placement tags applied to nodes in the node type as key/value pairs, which can be used to indicate where certain services (workload) should run. Updating this will override the current values.for example: --placement-property NodeColor=Green SomeProperty=5.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.