NodeTypeDescription

Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.

Properties

Name Type Required
name string Yes
placementProperties map of string to string No
capacities map of string to string No
clientConnectionEndpointPort integer Yes
httpGatewayEndpointPort integer Yes
durabilityLevel string (enum) No
applicationPorts EndpointRangeDescription No
ephemeralPorts EndpointRangeDescription No
isPrimary boolean Yes
vmInstanceCount integer Yes
reverseProxyEndpointPort integer No

name

Type: string
Required: Yes

The name of the node type.


placementProperties

Type: map of string to string
Required: No

The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.


capacities

Type: map of string to string
Required: No

The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.


clientConnectionEndpointPort

Type: integer
Required: Yes

The TCP cluster management endpoint port.


httpGatewayEndpointPort

Type: integer
Required: Yes

The HTTP cluster management endpoint port.


durabilityLevel

Type: string (enum)
Required: No

The durability level of the node type. Learn about DurabilityLevel.

  • Bronze - No privileges. This is the default.
  • Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.
  • Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.

applicationPorts

Type: EndpointRangeDescription
Required: No

The range of ports from which cluster assigned port to Service Fabric applications.


ephemeralPorts

Type: EndpointRangeDescription
Required: No

The range of empheral ports that nodes in this node type should be configured with.


isPrimary

Type: boolean
Required: Yes

The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters.


vmInstanceCount

Type: integer
Required: Yes
InclusiveMaximum: 2147483647
InclusiveMinimum: 1

The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.


reverseProxyEndpointPort

Type: integer
Required: No

The endpoint used by reverse proxy.