Share via

NodeTypeDescription interface

  • Reference
Package:
@azure/arm-servicefabric

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

Properties

applicationPorts

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

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

The TCP cluster management endpoint port.
durabilityLevel

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.
ephemeralPorts

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

The HTTP cluster management endpoint port.
isPrimary

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.
isStateless

Indicates if the node type can only host Stateless workloads.
multipleAvailabilityZones

Indicates if the node type is enabled to support multiple zones.
name

The name of the node type.
placementProperties

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

The endpoint used by reverse proxy.
vmInstanceCount

VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation.

Property Details

applicationPorts

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

applicationPorts?: EndpointRangeDescription

Property Value

EndpointRangeDescription

capacities

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.

capacities?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

clientConnectionEndpointPort

The TCP cluster management endpoint port.

clientConnectionEndpointPort: number

Property Value

number

durabilityLevel

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.
durabilityLevel?: string

Property Value

string

ephemeralPorts

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

ephemeralPorts?: EndpointRangeDescription

Property Value

EndpointRangeDescription

httpGatewayEndpointPort

The HTTP cluster management endpoint port.

httpGatewayEndpointPort: number

Property Value

number

isPrimary

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.

isPrimary: boolean

Property Value

boolean

isStateless

Indicates if the node type can only host Stateless workloads.

isStateless?: boolean

Property Value

boolean

multipleAvailabilityZones

Indicates if the node type is enabled to support multiple zones.

multipleAvailabilityZones?: boolean

Property Value

boolean

name

The name of the node type.

name: string

Property Value

string

placementProperties

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

placementProperties?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

reverseProxyEndpointPort

The endpoint used by reverse proxy.

reverseProxyEndpointPort?: number

Property Value

number

vmInstanceCount

VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation.

vmInstanceCount: number

Property Value

number