NodeTypeDescription Class

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

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.servicefabric._serialization.Model
NodeTypeDescription

Constructor

NodeTypeDescription(*, name: str, client_connection_endpoint_port: int, http_gateway_endpoint_port: int, is_primary: bool, vm_instance_count: int, placement_properties: Dict[str, str] | None = None, capacities: Dict[str, str] | None = None, durability_level: str | _models.DurabilityLevel | None = None, application_ports: _models.EndpointRangeDescription | None = None, ephemeral_ports: _models.EndpointRangeDescription | None = None, reverse_proxy_endpoint_port: int | None = None, is_stateless: bool | None = None, multiple_availability_zones: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

The name of the node type. Required.

placement_properties

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

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.

client_connection_endpoint_port
int

The TCP cluster management endpoint port. Required.

http_gateway_endpoint_port
int

The HTTP cluster management endpoint port. Required.

durability_level

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. Known values are: "Bronze", "Silver", and "Gold".

application_ports

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

ephemeral_ports

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

is_primary

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

vm_instance_count
int

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

reverse_proxy_endpoint_port
int

The endpoint used by reverse proxy.

is_stateless

Indicates if the node type can only host Stateless workloads.

multiple_availability_zones

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

Variables

Name Description
name
str

The name of the node type. Required.

placement_properties

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

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.

client_connection_endpoint_port
int

The TCP cluster management endpoint port. Required.

http_gateway_endpoint_port
int

The HTTP cluster management endpoint port. Required.

durability_level

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. Known values are: "Bronze", "Silver", and "Gold".

application_ports

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

ephemeral_ports

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

is_primary

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

vm_instance_count
int

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

reverse_proxy_endpoint_port
int

The endpoint used by reverse proxy.

is_stateless

Indicates if the node type can only host Stateless workloads.

multiple_availability_zones

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