GetNodeTypeResult

data class GetNodeTypeResult(val additionalDataDisks: List<VmssDataDiskResponse>? = null, val applicationPorts: EndpointRangeDescriptionResponse? = null, val capacities: Map<String, String>? = null, val dataDiskLetter: String? = null, val dataDiskSizeGB: Int? = null, val dataDiskType: String? = null, val enableAcceleratedNetworking: Boolean? = null, val enableEncryptionAtHost: Boolean? = null, val enableNodePublicIP: Boolean? = null, val enableOverProvisioning: Boolean? = null, val ephemeralPorts: EndpointRangeDescriptionResponse? = null, val evictionPolicy: String? = null, val frontendConfigurations: List<FrontendConfigurationResponse>? = null, val hostGroupId: String? = null, val id: String, val isPrimary: Boolean, val isSpotVM: Boolean? = null, val isStateless: Boolean? = null, val multiplePlacementGroups: Boolean? = null, val name: String, val natGatewayId: String? = null, val networkSecurityRules: List<NetworkSecurityRuleResponse>? = null, val placementProperties: Map<String, String>? = null, val provisioningState: String, val secureBootEnabled: Boolean? = null, val securityType: String? = null, val sku: NodeTypeSkuResponse? = null, val spotRestoreTimeout: String? = null, val subnetId: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val useDefaultPublicLoadBalancer: Boolean? = null, val useEphemeralOSDisk: Boolean? = null, val useTempDataDisk: Boolean? = null, val vmExtensions: List<VMSSExtensionResponse>? = null, val vmImageOffer: String? = null, val vmImagePlan: VmImagePlanResponse? = null, val vmImagePublisher: String? = null, val vmImageResourceId: String? = null, val vmImageSku: String? = null, val vmImageVersion: String? = null, val vmInstanceCount: Int, val vmManagedIdentity: VmManagedIdentityResponse? = null, val vmSecrets: List<VaultSecretGroupResponse>? = null, val vmSetupActions: List<String>? = null, val vmSharedGalleryImageId: String? = null, val vmSize: String? = null, val zones: List<String>? = null)

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

Constructors

Link copied to clipboard
constructor(additionalDataDisks: List<VmssDataDiskResponse>? = null, applicationPorts: EndpointRangeDescriptionResponse? = null, capacities: Map<String, String>? = null, dataDiskLetter: String? = null, dataDiskSizeGB: Int? = null, dataDiskType: String? = null, enableAcceleratedNetworking: Boolean? = null, enableEncryptionAtHost: Boolean? = null, enableNodePublicIP: Boolean? = null, enableOverProvisioning: Boolean? = null, ephemeralPorts: EndpointRangeDescriptionResponse? = null, evictionPolicy: String? = null, frontendConfigurations: List<FrontendConfigurationResponse>? = null, hostGroupId: String? = null, id: String, isPrimary: Boolean, isSpotVM: Boolean? = null, isStateless: Boolean? = null, multiplePlacementGroups: Boolean? = null, name: String, natGatewayId: String? = null, networkSecurityRules: List<NetworkSecurityRuleResponse>? = null, placementProperties: Map<String, String>? = null, provisioningState: String, secureBootEnabled: Boolean? = null, securityType: String? = null, sku: NodeTypeSkuResponse? = null, spotRestoreTimeout: String? = null, subnetId: String? = null, systemData: SystemDataResponse, tags: Map<String, String>? = null, type: String, useDefaultPublicLoadBalancer: Boolean? = null, useEphemeralOSDisk: Boolean? = null, useTempDataDisk: Boolean? = null, vmExtensions: List<VMSSExtensionResponse>? = null, vmImageOffer: String? = null, vmImagePlan: VmImagePlanResponse? = null, vmImagePublisher: String? = null, vmImageResourceId: String? = null, vmImageSku: String? = null, vmImageVersion: String? = null, vmInstanceCount: Int, vmManagedIdentity: VmManagedIdentityResponse? = null, vmSecrets: List<VaultSecretGroupResponse>? = null, vmSetupActions: List<String>? = null, vmSharedGalleryImageId: String? = null, vmSize: String? = null, zones: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Additional managed data disks.

Link copied to clipboard

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

Link copied to clipboard
val capacities: Map<String, String>? = null

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.

Link copied to clipboard
val dataDiskLetter: String? = null

Managed data disk letter. It can not use the reserved letter C or D and it can not change after created.

Link copied to clipboard
val dataDiskSizeGB: Int? = null

Disk size for the managed disk attached to the vms on the node type in GBs.

Link copied to clipboard
val dataDiskType: String? = null

Managed data disk type. Specifies the storage account type for the managed disk

Link copied to clipboard

Specifies whether the network interface is accelerated networking-enabled.

Link copied to clipboard

Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource.

Link copied to clipboard

Specifies whether each node is allocated its own public IP address. This is only supported on secondary node types with custom Load Balancers.

Link copied to clipboard

Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types.

Link copied to clipboard

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

Link copied to clipboard
val evictionPolicy: String? = null

Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete.

Link copied to clipboard

Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created.

Link copied to clipboard
val hostGroupId: String? = null

Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts.

Link copied to clipboard
val id: String

Azure resource identifier.

Link copied to clipboard

Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created.

Link copied to clipboard
val isSpotVM: Boolean? = null

Indicates whether the node type will be Spot Virtual Machines. Azure will allocate the VMs if there is capacity available and the VMs can be evicted at any time.

Link copied to clipboard
val isStateless: Boolean? = null

Indicates if the node type can only host Stateless workloads.

Link copied to clipboard

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

Link copied to clipboard

Azure resource name.

Link copied to clipboard
val natGatewayId: String? = null

Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer.

Link copied to clipboard

The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations.

Link copied to clipboard

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

Link copied to clipboard

The provisioning state of the node type resource.

Link copied to clipboard

Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch SecurityType

Link copied to clipboard
val securityType: String? = null

Specifies the security type of the nodeType. Only TrustedLaunch is currently supported

Link copied to clipboard

The node type sku.

Link copied to clipboard

Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601.

Link copied to clipboard
val subnetId: String? = null

Indicates the resource id of the subnet for the node type.

Link copied to clipboard

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
val tags: Map<String, String>? = null

Azure resource tags.

Link copied to clipboard

Azure resource type.

Link copied to clipboard

Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity.

Link copied to clipboard

Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature.

Link copied to clipboard

Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types.

Link copied to clipboard

Set of extensions that should be installed onto the virtual machines.

Link copied to clipboard
val vmImageOffer: String? = null

The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer.

Link copied to clipboard

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

Link copied to clipboard

The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer.

Link copied to clipboard

Indicates the resource id of the vm image. This parameter is used for custom vm image.

Link copied to clipboard
val vmImageSku: String? = null

The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter.

Link copied to clipboard
val vmImageVersion: String? = null

The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

Link copied to clipboard

The number of nodes in the node type.

Values:
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale.

Link copied to clipboard

Identities to assign to the virtual machine scale set under the node type.

Link copied to clipboard

The secrets to install in the virtual machines.

Link copied to clipboard
val vmSetupActions: List<String>? = null

Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime.

Link copied to clipboard

Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image.

Link copied to clipboard
val vmSize: String? = null

The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3.

Link copied to clipboard
val zones: List<String>? = null

Specifies the availability zones where the node type would span across. If the cluster is not spanning across availability zones, initiates az migration for the cluster.