Microsoft.ServiceFabric (preview:2024-11-01)

2025/06/20 • 4 updated methods

NodeTypes_ListByManagedClusters (updated)
Description :  Gets all Node types of the specified managed cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NodeTypes_ListByManagedClusters",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "vmExtensions": {
                  "$properties": {
                    "properties": [
                      {
                        "#name": "settings",
                        "Type": {
                          "new": "string",
                          "old": "object"
                        }
                      },
                      {
                        "#name": "protectedSettings",
                        "Type": {
                          "new": "string",
                          "old": "object"
                        }
                      }
                    ]
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NodeType items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: 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. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for the managed disk attached to the vms on the node type in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: False ,
}
enum ,
dataDiskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: False ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: 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. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name {UppercaseThumbprint}.crt for the X509 certificate file and {UppercaseThumbprint}.prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
setupOrder:
{
Description: Indicates the setup order for the extension. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: 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. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
applicationGatewayBackendAddressPoolId:
{
Description: The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: Protocol applies to HTTP. ,
https: Protocol applies to HTTPS. ,
tcp: Protocol applies to TCP. ,
udp: Protocol applies to UDP. ,
icmp: Protocol applies to ICMP. ,
ah: Protocol applies to AH. ,
esp: Protocol applies to ESP. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
sourceAddressPrefix:
{
Description: The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ,
Required: False ,
}
string ,
destinationAddressPrefix:
{
Description: The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ,
Required: False ,
}
string ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: The network traffic is allowed. ,
deny: The network traffic is denied. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: Inbound direction. ,
outbound: Outbound direction. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
additionalDataDisks:
{
Description: Additional managed data disks. ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk. ,
Format: int32 ,
Required: True ,
}
integer ,
diskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
diskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: True ,
}
enum ,
diskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: True ,
}
string ,
}
,
]
,
enableEncryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: The resource does not have a provisioning state. ,
Creating: The resource is being created. ,
Created: The resource is created. ,
Updating: The resource is being updated. ,
Succeeded: The resource provisioning has succeeded. ,
Failed: The resource provisioning has failed. ,
Canceled: The resource provisioning has been canceled. ,
Deleting: The resource is being deleted. ,
Deleted: The resource has been deleted. ,
Other: The resource provisioning state is a state other than the previously specified states. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
useDefaultPublicLoadBalancer:
{
Description: 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. ,
Required: False ,
}
boolean ,
useTempDataDisk:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableOverProvisioning:
{
Description: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. ,
Required: False ,
}
boolean ,
zones:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSpotVM:
{
Description: 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. ,
Required: False ,
}
boolean ,
hostGroupId:
{
Description: Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts. ,
Required: False ,
}
string ,
useEphemeralOSDisk:
{
Description: Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature. ,
Required: False ,
}
boolean ,
spotRestoreTimeout:
{
Description: Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601. ,
Required: False ,
}
string ,
evictionPolicy:
{
Description: Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete. ,
Enum:
{
Delete: Eviction policy will be Delete for SPOT vms. ,
Deallocate: Eviction policy will be Deallocate for SPOT vms. ,
}
,
Required: False ,
}
enum ,
vmImageResourceId:
{
Description: Indicates the resource id of the vm image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
subnetId:
{
Description: Indicates the resource id of the subnet for the node type. ,
Format: arm-id ,
Required: False ,
}
string ,
vmSetupActions:
{
Description: Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime. ,
Required: False ,
}
[
string ,
]
,
securityType:
{
Description: Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM. ,
Enum:
{
TrustedLaunch: Trusted Launch is a security type that secures generation 2 virtual machines. ,
Standard: Standard is the default security type for all machines. ,
ConfidentialVM: ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host. ,
}
,
Required: False ,
}
enum ,
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. ,
Enum:
{
DiskWithVMGuestState: For encryption of the managed disk along with VMGuestState blob. ,
VMGuestStateOnly: For encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType. ,
Required: False ,
}
boolean ,
enableNodePublicIP:
{
Description: Specifies whether each node is allocated its own public IPv4 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
enableNodePublicIPv6:
{
Description: Specifies whether each node is allocated its own public IPv6 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
vmSharedGalleryImageId:
{
Description: Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
natGatewayId:
{
Description: Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer. ,
Format: arm-id ,
Required: False ,
}
string ,
natConfigurations:
{
Description: Specifies the NAT configuration on default public Load Balancer for the node type. This is only supported for node types use the default public Load Balancer. ,
Required: False ,
}
[
{
backendPort:
{
Description: The internal port for the NAT configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeStart:
{
Description: The port range start for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: The port range end for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmImagePlan:
{
Description: 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. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
}
,
serviceArtifactReferenceId:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. ,
Format: arm-id ,
Required: False ,
}
string ,
dscpConfigurationId:
{
Description: Specifies the resource id of the DSCP configuration to apply to the node type network interface. ,
Format: arm-id ,
Required: False ,
}
string ,
additionalNetworkInterfaceConfigurations:
{
Description: Specifies the settings for any additional secondary network interfaces to attach to the node type. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
dscpConfiguration:
{
Description: Specifies the DSCP configuration to apply to the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A node type can reference backend address pools of multiple application gateways. Multiple node types cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A node type can reference backend address pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A node type can reference inbound nat pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
subnet:
{
Description: Specifies the subnet of the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
privateIPAddressVersion:
{
Description: Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's private IP is IPv4. ,
IPv6: The IP configuration's private IP is IPv6. ,
}
,
Required: False ,
}
enum ,
publicIPAddressConfiguration:
{
Description: The public IP address configuration of the network interface. ,
Required: False ,
}
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
ipTags:
{
Description: Specifies the list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: True ,
}
string ,
}
,
]
,
publicIPAddressVersion:
{
Description: Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's public IP is IPv4. ,
IPv6: The IP configuration's public IP is IPv6. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix:
{
Description: Specifies the computer name prefix. Limited to 9 characters. If specified, allows for a longer name to be specified for the node type name. ,
Required: False ,
}
string ,
vmApplications:
{
Description: Specifies the gallery applications that should be made available to the underlying VMSS. ,
Required: False ,
}
[
{
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided. ,
Format: uri ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the underlying VMSS. ,
Required: False ,
}
boolean ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed. ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}. ,
Format: arm-id ,
Required: True ,
}
string ,
vmGalleryTags:
{
Description: Optional, Specifies a passthrough value for more generic context. Accepts a JSON-formatted string e.g. '{"Tag1":"Value1","Tag2":"Value2"}'. ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. Name is internally generated and is used in auto-scale scenarios. Property does not allow to be changed to other values than generated. To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type. Possible Values: **Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type. If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeTypes_Get (updated)
Description :  Get a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NodeTypes_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "vmExtensions": {
              "$properties": {
                "properties": [
                  {
                    "#name": "settings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  },
                  {
                    "#name": "protectedSettings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: 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. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for the managed disk attached to the vms on the node type in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: False ,
}
enum ,
dataDiskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: False ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: 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. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name {UppercaseThumbprint}.crt for the X509 certificate file and {UppercaseThumbprint}.prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
setupOrder:
{
Description: Indicates the setup order for the extension. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: 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. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
applicationGatewayBackendAddressPoolId:
{
Description: The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: Protocol applies to HTTP. ,
https: Protocol applies to HTTPS. ,
tcp: Protocol applies to TCP. ,
udp: Protocol applies to UDP. ,
icmp: Protocol applies to ICMP. ,
ah: Protocol applies to AH. ,
esp: Protocol applies to ESP. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
sourceAddressPrefix:
{
Description: The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ,
Required: False ,
}
string ,
destinationAddressPrefix:
{
Description: The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ,
Required: False ,
}
string ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: The network traffic is allowed. ,
deny: The network traffic is denied. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: Inbound direction. ,
outbound: Outbound direction. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
additionalDataDisks:
{
Description: Additional managed data disks. ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk. ,
Format: int32 ,
Required: True ,
}
integer ,
diskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
diskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: True ,
}
enum ,
diskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: True ,
}
string ,
}
,
]
,
enableEncryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: The resource does not have a provisioning state. ,
Creating: The resource is being created. ,
Created: The resource is created. ,
Updating: The resource is being updated. ,
Succeeded: The resource provisioning has succeeded. ,
Failed: The resource provisioning has failed. ,
Canceled: The resource provisioning has been canceled. ,
Deleting: The resource is being deleted. ,
Deleted: The resource has been deleted. ,
Other: The resource provisioning state is a state other than the previously specified states. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
useDefaultPublicLoadBalancer:
{
Description: 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. ,
Required: False ,
}
boolean ,
useTempDataDisk:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableOverProvisioning:
{
Description: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. ,
Required: False ,
}
boolean ,
zones:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSpotVM:
{
Description: 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. ,
Required: False ,
}
boolean ,
hostGroupId:
{
Description: Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts. ,
Required: False ,
}
string ,
useEphemeralOSDisk:
{
Description: Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature. ,
Required: False ,
}
boolean ,
spotRestoreTimeout:
{
Description: Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601. ,
Required: False ,
}
string ,
evictionPolicy:
{
Description: Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete. ,
Enum:
{
Delete: Eviction policy will be Delete for SPOT vms. ,
Deallocate: Eviction policy will be Deallocate for SPOT vms. ,
}
,
Required: False ,
}
enum ,
vmImageResourceId:
{
Description: Indicates the resource id of the vm image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
subnetId:
{
Description: Indicates the resource id of the subnet for the node type. ,
Format: arm-id ,
Required: False ,
}
string ,
vmSetupActions:
{
Description: Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime. ,
Required: False ,
}
[
string ,
]
,
securityType:
{
Description: Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM. ,
Enum:
{
TrustedLaunch: Trusted Launch is a security type that secures generation 2 virtual machines. ,
Standard: Standard is the default security type for all machines. ,
ConfidentialVM: ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host. ,
}
,
Required: False ,
}
enum ,
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. ,
Enum:
{
DiskWithVMGuestState: For encryption of the managed disk along with VMGuestState blob. ,
VMGuestStateOnly: For encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType. ,
Required: False ,
}
boolean ,
enableNodePublicIP:
{
Description: Specifies whether each node is allocated its own public IPv4 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
enableNodePublicIPv6:
{
Description: Specifies whether each node is allocated its own public IPv6 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
vmSharedGalleryImageId:
{
Description: Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
natGatewayId:
{
Description: Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer. ,
Format: arm-id ,
Required: False ,
}
string ,
natConfigurations:
{
Description: Specifies the NAT configuration on default public Load Balancer for the node type. This is only supported for node types use the default public Load Balancer. ,
Required: False ,
}
[
{
backendPort:
{
Description: The internal port for the NAT configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeStart:
{
Description: The port range start for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: The port range end for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmImagePlan:
{
Description: 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. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
}
,
serviceArtifactReferenceId:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. ,
Format: arm-id ,
Required: False ,
}
string ,
dscpConfigurationId:
{
Description: Specifies the resource id of the DSCP configuration to apply to the node type network interface. ,
Format: arm-id ,
Required: False ,
}
string ,
additionalNetworkInterfaceConfigurations:
{
Description: Specifies the settings for any additional secondary network interfaces to attach to the node type. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
dscpConfiguration:
{
Description: Specifies the DSCP configuration to apply to the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A node type can reference backend address pools of multiple application gateways. Multiple node types cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A node type can reference backend address pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A node type can reference inbound nat pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
subnet:
{
Description: Specifies the subnet of the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
privateIPAddressVersion:
{
Description: Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's private IP is IPv4. ,
IPv6: The IP configuration's private IP is IPv6. ,
}
,
Required: False ,
}
enum ,
publicIPAddressConfiguration:
{
Description: The public IP address configuration of the network interface. ,
Required: False ,
}
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
ipTags:
{
Description: Specifies the list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: True ,
}
string ,
}
,
]
,
publicIPAddressVersion:
{
Description: Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's public IP is IPv4. ,
IPv6: The IP configuration's public IP is IPv6. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix:
{
Description: Specifies the computer name prefix. Limited to 9 characters. If specified, allows for a longer name to be specified for the node type name. ,
Required: False ,
}
string ,
vmApplications:
{
Description: Specifies the gallery applications that should be made available to the underlying VMSS. ,
Required: False ,
}
[
{
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided. ,
Format: uri ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the underlying VMSS. ,
Required: False ,
}
boolean ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed. ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}. ,
Format: arm-id ,
Required: True ,
}
string ,
vmGalleryTags:
{
Description: Optional, Specifies a passthrough value for more generic context. Accepts a JSON-formatted string e.g. '{"Tag1":"Value1","Tag2":"Value2"}'. ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. Name is internally generated and is used in auto-scale scenarios. Property does not allow to be changed to other values than generated. To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type. Possible Values: **Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type. If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeTypes_CreateOrUpdate (updated)
Description :  Create or update a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NodeTypes_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "vmExtensions": {
              "$properties": {
                "properties": [
                  {
                    "#name": "settings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  },
                  {
                    "#name": "protectedSettings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "vmExtensions": {
              "$properties": {
                "properties": [
                  {
                    "#name": "settings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  },
                  {
                    "#name": "protectedSettings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "vmExtensions": {
              "$properties": {
                "properties": [
                  {
                    "#name": "settings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  },
                  {
                    "#name": "protectedSettings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
parameters:
{
Description: The node type resource. ,
Required: True ,
}
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: 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. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for the managed disk attached to the vms on the node type in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: False ,
}
enum ,
dataDiskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: False ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: 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. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name {UppercaseThumbprint}.crt for the X509 certificate file and {UppercaseThumbprint}.prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
setupOrder:
{
Description: Indicates the setup order for the extension. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: 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. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
applicationGatewayBackendAddressPoolId:
{
Description: The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: Protocol applies to HTTP. ,
https: Protocol applies to HTTPS. ,
tcp: Protocol applies to TCP. ,
udp: Protocol applies to UDP. ,
icmp: Protocol applies to ICMP. ,
ah: Protocol applies to AH. ,
esp: Protocol applies to ESP. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
sourceAddressPrefix:
{
Description: The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ,
Required: False ,
}
string ,
destinationAddressPrefix:
{
Description: The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ,
Required: False ,
}
string ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: The network traffic is allowed. ,
deny: The network traffic is denied. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: Inbound direction. ,
outbound: Outbound direction. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
additionalDataDisks:
{
Description: Additional managed data disks. ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk. ,
Format: int32 ,
Required: True ,
}
integer ,
diskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
diskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: True ,
}
enum ,
diskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: True ,
}
string ,
}
,
]
,
enableEncryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: The resource does not have a provisioning state. ,
Creating: The resource is being created. ,
Created: The resource is created. ,
Updating: The resource is being updated. ,
Succeeded: The resource provisioning has succeeded. ,
Failed: The resource provisioning has failed. ,
Canceled: The resource provisioning has been canceled. ,
Deleting: The resource is being deleted. ,
Deleted: The resource has been deleted. ,
Other: The resource provisioning state is a state other than the previously specified states. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
useDefaultPublicLoadBalancer:
{
Description: 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. ,
Required: False ,
}
boolean ,
useTempDataDisk:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableOverProvisioning:
{
Description: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. ,
Required: False ,
}
boolean ,
zones:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSpotVM:
{
Description: 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. ,
Required: False ,
}
boolean ,
hostGroupId:
{
Description: Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts. ,
Required: False ,
}
string ,
useEphemeralOSDisk:
{
Description: Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature. ,
Required: False ,
}
boolean ,
spotRestoreTimeout:
{
Description: Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601. ,
Required: False ,
}
string ,
evictionPolicy:
{
Description: Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete. ,
Enum:
{
Delete: Eviction policy will be Delete for SPOT vms. ,
Deallocate: Eviction policy will be Deallocate for SPOT vms. ,
}
,
Required: False ,
}
enum ,
vmImageResourceId:
{
Description: Indicates the resource id of the vm image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
subnetId:
{
Description: Indicates the resource id of the subnet for the node type. ,
Format: arm-id ,
Required: False ,
}
string ,
vmSetupActions:
{
Description: Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime. ,
Required: False ,
}
[
string ,
]
,
securityType:
{
Description: Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM. ,
Enum:
{
TrustedLaunch: Trusted Launch is a security type that secures generation 2 virtual machines. ,
Standard: Standard is the default security type for all machines. ,
ConfidentialVM: ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host. ,
}
,
Required: False ,
}
enum ,
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. ,
Enum:
{
DiskWithVMGuestState: For encryption of the managed disk along with VMGuestState blob. ,
VMGuestStateOnly: For encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType. ,
Required: False ,
}
boolean ,
enableNodePublicIP:
{
Description: Specifies whether each node is allocated its own public IPv4 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
enableNodePublicIPv6:
{
Description: Specifies whether each node is allocated its own public IPv6 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
vmSharedGalleryImageId:
{
Description: Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
natGatewayId:
{
Description: Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer. ,
Format: arm-id ,
Required: False ,
}
string ,
natConfigurations:
{
Description: Specifies the NAT configuration on default public Load Balancer for the node type. This is only supported for node types use the default public Load Balancer. ,
Required: False ,
}
[
{
backendPort:
{
Description: The internal port for the NAT configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeStart:
{
Description: The port range start for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: The port range end for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmImagePlan:
{
Description: 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. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
}
,
serviceArtifactReferenceId:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. ,
Format: arm-id ,
Required: False ,
}
string ,
dscpConfigurationId:
{
Description: Specifies the resource id of the DSCP configuration to apply to the node type network interface. ,
Format: arm-id ,
Required: False ,
}
string ,
additionalNetworkInterfaceConfigurations:
{
Description: Specifies the settings for any additional secondary network interfaces to attach to the node type. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
dscpConfiguration:
{
Description: Specifies the DSCP configuration to apply to the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A node type can reference backend address pools of multiple application gateways. Multiple node types cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A node type can reference backend address pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A node type can reference inbound nat pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
subnet:
{
Description: Specifies the subnet of the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
privateIPAddressVersion:
{
Description: Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's private IP is IPv4. ,
IPv6: The IP configuration's private IP is IPv6. ,
}
,
Required: False ,
}
enum ,
publicIPAddressConfiguration:
{
Description: The public IP address configuration of the network interface. ,
Required: False ,
}
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
ipTags:
{
Description: Specifies the list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: True ,
}
string ,
}
,
]
,
publicIPAddressVersion:
{
Description: Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's public IP is IPv4. ,
IPv6: The IP configuration's public IP is IPv6. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix:
{
Description: Specifies the computer name prefix. Limited to 9 characters. If specified, allows for a longer name to be specified for the node type name. ,
Required: False ,
}
string ,
vmApplications:
{
Description: Specifies the gallery applications that should be made available to the underlying VMSS. ,
Required: False ,
}
[
{
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided. ,
Format: uri ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the underlying VMSS. ,
Required: False ,
}
boolean ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed. ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}. ,
Format: arm-id ,
Required: True ,
}
string ,
vmGalleryTags:
{
Description: Optional, Specifies a passthrough value for more generic context. Accepts a JSON-formatted string e.g. '{"Tag1":"Value1","Tag2":"Value2"}'. ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. Name is internally generated and is used in auto-scale scenarios. Property does not allow to be changed to other values than generated. To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type. Possible Values: **Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type. If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: 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. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for the managed disk attached to the vms on the node type in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: False ,
}
enum ,
dataDiskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: False ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: 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. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name {UppercaseThumbprint}.crt for the X509 certificate file and {UppercaseThumbprint}.prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
setupOrder:
{
Description: Indicates the setup order for the extension. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: 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. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
applicationGatewayBackendAddressPoolId:
{
Description: The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: Protocol applies to HTTP. ,
https: Protocol applies to HTTPS. ,
tcp: Protocol applies to TCP. ,
udp: Protocol applies to UDP. ,
icmp: Protocol applies to ICMP. ,
ah: Protocol applies to AH. ,
esp: Protocol applies to ESP. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
sourceAddressPrefix:
{
Description: The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ,
Required: False ,
}
string ,
destinationAddressPrefix:
{
Description: The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ,
Required: False ,
}
string ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: The network traffic is allowed. ,
deny: The network traffic is denied. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: Inbound direction. ,
outbound: Outbound direction. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
additionalDataDisks:
{
Description: Additional managed data disks. ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk. ,
Format: int32 ,
Required: True ,
}
integer ,
diskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
diskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: True ,
}
enum ,
diskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: True ,
}
string ,
}
,
]
,
enableEncryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: The resource does not have a provisioning state. ,
Creating: The resource is being created. ,
Created: The resource is created. ,
Updating: The resource is being updated. ,
Succeeded: The resource provisioning has succeeded. ,
Failed: The resource provisioning has failed. ,
Canceled: The resource provisioning has been canceled. ,
Deleting: The resource is being deleted. ,
Deleted: The resource has been deleted. ,
Other: The resource provisioning state is a state other than the previously specified states. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
useDefaultPublicLoadBalancer:
{
Description: 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. ,
Required: False ,
}
boolean ,
useTempDataDisk:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableOverProvisioning:
{
Description: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. ,
Required: False ,
}
boolean ,
zones:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSpotVM:
{
Description: 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. ,
Required: False ,
}
boolean ,
hostGroupId:
{
Description: Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts. ,
Required: False ,
}
string ,
useEphemeralOSDisk:
{
Description: Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature. ,
Required: False ,
}
boolean ,
spotRestoreTimeout:
{
Description: Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601. ,
Required: False ,
}
string ,
evictionPolicy:
{
Description: Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete. ,
Enum:
{
Delete: Eviction policy will be Delete for SPOT vms. ,
Deallocate: Eviction policy will be Deallocate for SPOT vms. ,
}
,
Required: False ,
}
enum ,
vmImageResourceId:
{
Description: Indicates the resource id of the vm image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
subnetId:
{
Description: Indicates the resource id of the subnet for the node type. ,
Format: arm-id ,
Required: False ,
}
string ,
vmSetupActions:
{
Description: Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime. ,
Required: False ,
}
[
string ,
]
,
securityType:
{
Description: Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM. ,
Enum:
{
TrustedLaunch: Trusted Launch is a security type that secures generation 2 virtual machines. ,
Standard: Standard is the default security type for all machines. ,
ConfidentialVM: ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host. ,
}
,
Required: False ,
}
enum ,
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. ,
Enum:
{
DiskWithVMGuestState: For encryption of the managed disk along with VMGuestState blob. ,
VMGuestStateOnly: For encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType. ,
Required: False ,
}
boolean ,
enableNodePublicIP:
{
Description: Specifies whether each node is allocated its own public IPv4 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
enableNodePublicIPv6:
{
Description: Specifies whether each node is allocated its own public IPv6 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
vmSharedGalleryImageId:
{
Description: Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
natGatewayId:
{
Description: Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer. ,
Format: arm-id ,
Required: False ,
}
string ,
natConfigurations:
{
Description: Specifies the NAT configuration on default public Load Balancer for the node type. This is only supported for node types use the default public Load Balancer. ,
Required: False ,
}
[
{
backendPort:
{
Description: The internal port for the NAT configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeStart:
{
Description: The port range start for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: The port range end for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmImagePlan:
{
Description: 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. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
}
,
serviceArtifactReferenceId:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. ,
Format: arm-id ,
Required: False ,
}
string ,
dscpConfigurationId:
{
Description: Specifies the resource id of the DSCP configuration to apply to the node type network interface. ,
Format: arm-id ,
Required: False ,
}
string ,
additionalNetworkInterfaceConfigurations:
{
Description: Specifies the settings for any additional secondary network interfaces to attach to the node type. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
dscpConfiguration:
{
Description: Specifies the DSCP configuration to apply to the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A node type can reference backend address pools of multiple application gateways. Multiple node types cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A node type can reference backend address pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A node type can reference inbound nat pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
subnet:
{
Description: Specifies the subnet of the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
privateIPAddressVersion:
{
Description: Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's private IP is IPv4. ,
IPv6: The IP configuration's private IP is IPv6. ,
}
,
Required: False ,
}
enum ,
publicIPAddressConfiguration:
{
Description: The public IP address configuration of the network interface. ,
Required: False ,
}
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
ipTags:
{
Description: Specifies the list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: True ,
}
string ,
}
,
]
,
publicIPAddressVersion:
{
Description: Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's public IP is IPv4. ,
IPv6: The IP configuration's public IP is IPv6. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix:
{
Description: Specifies the computer name prefix. Limited to 9 characters. If specified, allows for a longer name to be specified for the node type name. ,
Required: False ,
}
string ,
vmApplications:
{
Description: Specifies the gallery applications that should be made available to the underlying VMSS. ,
Required: False ,
}
[
{
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided. ,
Format: uri ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the underlying VMSS. ,
Required: False ,
}
boolean ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed. ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}. ,
Format: arm-id ,
Required: True ,
}
string ,
vmGalleryTags:
{
Description: Optional, Specifies a passthrough value for more generic context. Accepts a JSON-formatted string e.g. '{"Tag1":"Value1","Tag2":"Value2"}'. ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. Name is internally generated and is used in auto-scale scenarios. Property does not allow to be changed to other values than generated. To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type. Possible Values: **Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type. If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Describes a node type in the cluster, each node type represents sub set of nodes in the cluster. ,
}
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: 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. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for the managed disk attached to the vms on the node type in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: False ,
}
enum ,
dataDiskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: False ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: 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. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name {UppercaseThumbprint}.crt for the X509 certificate file and {UppercaseThumbprint}.prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
setupOrder:
{
Description: Indicates the setup order for the extension. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: 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. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
applicationGatewayBackendAddressPoolId:
{
Description: The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: Protocol applies to HTTP. ,
https: Protocol applies to HTTPS. ,
tcp: Protocol applies to TCP. ,
udp: Protocol applies to UDP. ,
icmp: Protocol applies to ICMP. ,
ah: Protocol applies to AH. ,
esp: Protocol applies to ESP. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
sourceAddressPrefix:
{
Description: The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ,
Required: False ,
}
string ,
destinationAddressPrefix:
{
Description: The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ,
Required: False ,
}
string ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: The network traffic is allowed. ,
deny: The network traffic is denied. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: Inbound direction. ,
outbound: Outbound direction. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
additionalDataDisks:
{
Description: Additional managed data disks. ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk. ,
Format: int32 ,
Required: True ,
}
integer ,
diskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
diskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: True ,
}
enum ,
diskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: True ,
}
string ,
}
,
]
,
enableEncryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: The resource does not have a provisioning state. ,
Creating: The resource is being created. ,
Created: The resource is created. ,
Updating: The resource is being updated. ,
Succeeded: The resource provisioning has succeeded. ,
Failed: The resource provisioning has failed. ,
Canceled: The resource provisioning has been canceled. ,
Deleting: The resource is being deleted. ,
Deleted: The resource has been deleted. ,
Other: The resource provisioning state is a state other than the previously specified states. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
useDefaultPublicLoadBalancer:
{
Description: 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. ,
Required: False ,
}
boolean ,
useTempDataDisk:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableOverProvisioning:
{
Description: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. ,
Required: False ,
}
boolean ,
zones:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSpotVM:
{
Description: 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. ,
Required: False ,
}
boolean ,
hostGroupId:
{
Description: Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts. ,
Required: False ,
}
string ,
useEphemeralOSDisk:
{
Description: Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature. ,
Required: False ,
}
boolean ,
spotRestoreTimeout:
{
Description: Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601. ,
Required: False ,
}
string ,
evictionPolicy:
{
Description: Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete. ,
Enum:
{
Delete: Eviction policy will be Delete for SPOT vms. ,
Deallocate: Eviction policy will be Deallocate for SPOT vms. ,
}
,
Required: False ,
}
enum ,
vmImageResourceId:
{
Description: Indicates the resource id of the vm image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
subnetId:
{
Description: Indicates the resource id of the subnet for the node type. ,
Format: arm-id ,
Required: False ,
}
string ,
vmSetupActions:
{
Description: Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime. ,
Required: False ,
}
[
string ,
]
,
securityType:
{
Description: Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM. ,
Enum:
{
TrustedLaunch: Trusted Launch is a security type that secures generation 2 virtual machines. ,
Standard: Standard is the default security type for all machines. ,
ConfidentialVM: ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host. ,
}
,
Required: False ,
}
enum ,
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. ,
Enum:
{
DiskWithVMGuestState: For encryption of the managed disk along with VMGuestState blob. ,
VMGuestStateOnly: For encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType. ,
Required: False ,
}
boolean ,
enableNodePublicIP:
{
Description: Specifies whether each node is allocated its own public IPv4 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
enableNodePublicIPv6:
{
Description: Specifies whether each node is allocated its own public IPv6 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
vmSharedGalleryImageId:
{
Description: Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
natGatewayId:
{
Description: Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer. ,
Format: arm-id ,
Required: False ,
}
string ,
natConfigurations:
{
Description: Specifies the NAT configuration on default public Load Balancer for the node type. This is only supported for node types use the default public Load Balancer. ,
Required: False ,
}
[
{
backendPort:
{
Description: The internal port for the NAT configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeStart:
{
Description: The port range start for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: The port range end for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmImagePlan:
{
Description: 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. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
}
,
serviceArtifactReferenceId:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. ,
Format: arm-id ,
Required: False ,
}
string ,
dscpConfigurationId:
{
Description: Specifies the resource id of the DSCP configuration to apply to the node type network interface. ,
Format: arm-id ,
Required: False ,
}
string ,
additionalNetworkInterfaceConfigurations:
{
Description: Specifies the settings for any additional secondary network interfaces to attach to the node type. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
dscpConfiguration:
{
Description: Specifies the DSCP configuration to apply to the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A node type can reference backend address pools of multiple application gateways. Multiple node types cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A node type can reference backend address pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A node type can reference inbound nat pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
subnet:
{
Description: Specifies the subnet of the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
privateIPAddressVersion:
{
Description: Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's private IP is IPv4. ,
IPv6: The IP configuration's private IP is IPv6. ,
}
,
Required: False ,
}
enum ,
publicIPAddressConfiguration:
{
Description: The public IP address configuration of the network interface. ,
Required: False ,
}
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
ipTags:
{
Description: Specifies the list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: True ,
}
string ,
}
,
]
,
publicIPAddressVersion:
{
Description: Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's public IP is IPv4. ,
IPv6: The IP configuration's public IP is IPv6. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix:
{
Description: Specifies the computer name prefix. Limited to 9 characters. If specified, allows for a longer name to be specified for the node type name. ,
Required: False ,
}
string ,
vmApplications:
{
Description: Specifies the gallery applications that should be made available to the underlying VMSS. ,
Required: False ,
}
[
{
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided. ,
Format: uri ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the underlying VMSS. ,
Required: False ,
}
boolean ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed. ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}. ,
Format: arm-id ,
Required: True ,
}
string ,
vmGalleryTags:
{
Description: Optional, Specifies a passthrough value for more generic context. Accepts a JSON-formatted string e.g. '{"Tag1":"Value1","Tag2":"Value2"}'. ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. Name is internally generated and is used in auto-scale scenarios. Property does not allow to be changed to other values than generated. To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type. Possible Values: **Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type. If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeTypes_Update (updated)
Description :  Update the configuration of a node type of a given managed cluster, only updating tags.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NodeTypes_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "vmExtensions": {
              "$properties": {
                "properties": [
                  {
                    "#name": "settings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  },
                  {
                    "#name": "protectedSettings",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update the node type configuration. ,
Required: True ,
}
{
tags:
{
Description: Node type update parameters ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. Name is internally generated and is used in auto-scale scenarios. Property does not allow to be changed to other values than generated. To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type. Possible Values: **Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type. If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: 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. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for the managed disk attached to the vms on the node type in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: False ,
}
enum ,
dataDiskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: False ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: 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. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name {UppercaseThumbprint}.crt for the X509 certificate file and {UppercaseThumbprint}.prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
setupOrder:
{
Description: Indicates the setup order for the extension. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: 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. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
applicationGatewayBackendAddressPoolId:
{
Description: The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: Protocol applies to HTTP. ,
https: Protocol applies to HTTPS. ,
tcp: Protocol applies to TCP. ,
udp: Protocol applies to UDP. ,
icmp: Protocol applies to ICMP. ,
ah: Protocol applies to AH. ,
esp: Protocol applies to ESP. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
sourceAddressPrefix:
{
Description: The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ,
Required: False ,
}
string ,
destinationAddressPrefix:
{
Description: The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ,
Required: False ,
}
string ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: The network traffic is allowed. ,
deny: The network traffic is denied. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: Inbound direction. ,
outbound: Outbound direction. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
additionalDataDisks:
{
Description: Additional managed data disks. ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk. ,
Format: int32 ,
Required: True ,
}
integer ,
diskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
diskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_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. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: True ,
}
enum ,
diskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: True ,
}
string ,
}
,
]
,
enableEncryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: The resource does not have a provisioning state. ,
Creating: The resource is being created. ,
Created: The resource is created. ,
Updating: The resource is being updated. ,
Succeeded: The resource provisioning has succeeded. ,
Failed: The resource provisioning has failed. ,
Canceled: The resource provisioning has been canceled. ,
Deleting: The resource is being deleted. ,
Deleted: The resource has been deleted. ,
Other: The resource provisioning state is a state other than the previously specified states. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
useDefaultPublicLoadBalancer:
{
Description: 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. ,
Required: False ,
}
boolean ,
useTempDataDisk:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableOverProvisioning:
{
Description: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. ,
Required: False ,
}
boolean ,
zones:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSpotVM:
{
Description: 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. ,
Required: False ,
}
boolean ,
hostGroupId:
{
Description: Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts. ,
Required: False ,
}
string ,
useEphemeralOSDisk:
{
Description: Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature. ,
Required: False ,
}
boolean ,
spotRestoreTimeout:
{
Description: Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601. ,
Required: False ,
}
string ,
evictionPolicy:
{
Description: Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete. ,
Enum:
{
Delete: Eviction policy will be Delete for SPOT vms. ,
Deallocate: Eviction policy will be Deallocate for SPOT vms. ,
}
,
Required: False ,
}
enum ,
vmImageResourceId:
{
Description: Indicates the resource id of the vm image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
subnetId:
{
Description: Indicates the resource id of the subnet for the node type. ,
Format: arm-id ,
Required: False ,
}
string ,
vmSetupActions:
{
Description: Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime. ,
Required: False ,
}
[
string ,
]
,
securityType:
{
Description: Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM. ,
Enum:
{
TrustedLaunch: Trusted Launch is a security type that secures generation 2 virtual machines. ,
Standard: Standard is the default security type for all machines. ,
ConfidentialVM: ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host. ,
}
,
Required: False ,
}
enum ,
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. ,
Enum:
{
DiskWithVMGuestState: For encryption of the managed disk along with VMGuestState blob. ,
VMGuestStateOnly: For encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType. ,
Required: False ,
}
boolean ,
enableNodePublicIP:
{
Description: Specifies whether each node is allocated its own public IPv4 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
enableNodePublicIPv6:
{
Description: Specifies whether each node is allocated its own public IPv6 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
vmSharedGalleryImageId:
{
Description: Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
natGatewayId:
{
Description: Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer. ,
Format: arm-id ,
Required: False ,
}
string ,
natConfigurations:
{
Description: Specifies the NAT configuration on default public Load Balancer for the node type. This is only supported for node types use the default public Load Balancer. ,
Required: False ,
}
[
{
backendPort:
{
Description: The internal port for the NAT configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeStart:
{
Description: The port range start for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: The port range end for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmImagePlan:
{
Description: 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. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
}
,
serviceArtifactReferenceId:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. ,
Format: arm-id ,
Required: False ,
}
string ,
dscpConfigurationId:
{
Description: Specifies the resource id of the DSCP configuration to apply to the node type network interface. ,
Format: arm-id ,
Required: False ,
}
string ,
additionalNetworkInterfaceConfigurations:
{
Description: Specifies the settings for any additional secondary network interfaces to attach to the node type. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
dscpConfiguration:
{
Description: Specifies the DSCP configuration to apply to the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A node type can reference backend address pools of multiple application gateways. Multiple node types cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A node type can reference backend address pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A node type can reference inbound nat pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
subnet:
{
Description: Specifies the subnet of the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
privateIPAddressVersion:
{
Description: Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's private IP is IPv4. ,
IPv6: The IP configuration's private IP is IPv6. ,
}
,
Required: False ,
}
enum ,
publicIPAddressConfiguration:
{
Description: The public IP address configuration of the network interface. ,
Required: False ,
}
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
ipTags:
{
Description: Specifies the list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: True ,
}
string ,
}
,
]
,
publicIPAddressVersion:
{
Description: Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's public IP is IPv4. ,
IPv6: The IP configuration's public IP is IPv6. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix:
{
Description: Specifies the computer name prefix. Limited to 9 characters. If specified, allows for a longer name to be specified for the node type name. ,
Required: False ,
}
string ,
vmApplications:
{
Description: Specifies the gallery applications that should be made available to the underlying VMSS. ,
Required: False ,
}
[
{
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided. ,
Format: uri ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the underlying VMSS. ,
Required: False ,
}
boolean ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed. ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}. ,
Format: arm-id ,
Required: True ,
}
string ,
vmGalleryTags:
{
Description: Optional, Specifies a passthrough value for more generic context. Accepts a JSON-formatted string e.g. '{"Tag1":"Value1","Tag2":"Value2"}'. ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. Name is internally generated and is used in auto-scale scenarios. Property does not allow to be changed to other values than generated. To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type. Possible Values: **Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type. If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}