Microsoft.ServiceFabric managedClusters/nodeTypes 2021-01-01-preview

The managedClusters/nodeTypes resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.ServiceFabric/managedClusters/nodeTypes resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-01-01-preview' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: parentSymbolicName
  properties: {
    applicationPorts: {
      endPort: int
      startPort: int
    }
    capacities: {}
    dataDiskSizeGB: int
    ephemeralPorts: {
      endPort: int
      startPort: int
    }
    isPrimary: bool
    placementProperties: {}
    vmExtensions: [
      {
        name: 'string'
        properties: {
          autoUpgradeMinorVersion: bool
          forceUpdateTag: 'string'
          protectedSettings: any()
          provisionAfterExtensions: [ 'string' ]
          publisher: 'string'
          settings: any()
          type: 'string'
          typeHandlerVersion: 'string'
        }
      }
    ]
    vmImageOffer: 'string'
    vmImagePublisher: 'string'
    vmImageSku: 'string'
    vmImageVersion: 'string'
    vmInstanceCount: int
    vmManagedIdentity: {
      userAssignedIdentities: [ 'string' ]
    }
    vmSecrets: [
      {
        sourceVault: {
          id: 'string'
        }
        vaultCertificates: [
          {
            certificateStore: 'string'
            certificateUrl: 'string'
          }
        ]
      }
    ]
    vmSize: 'string'
  }
}

Property values

managedClusters/nodeTypes

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ServiceFabric/managedClusters/nodeTypes'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-01-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
tags Azure resource tags. Dictionary of tag names and values. See Tags in templates
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
parentSymbolicName
properties Describes a node type in the cluster, each node type represents sub set of nodes in the cluster. NodeTypeProperties

NodeTypeProperties

Name Description Value
applicationPorts Port range details EndpointRangeDescription
capacities The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. object
dataDiskSizeGB Disk size for each vm in the node type in GBs. int (required)
ephemeralPorts Port range details EndpointRangeDescription
isPrimary The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. bool (required)
placementProperties The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. object
vmExtensions Set of extensions that should be installed onto the virtual machines. VmssExtension[]
vmImageOffer The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. string
vmImagePublisher The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. string
vmImageSku The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. string
vmImageVersion 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'. string
vmInstanceCount The number of nodes in the node type. int (required)
vmManagedIdentity Identities for the virtual machine scale set under the node type. VmManagedIdentity
vmSecrets The secrets to install in the virtual machines. VaultSecretGroup[]
vmSize The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. string

EndpointRangeDescription

Name Description Value
endPort End port of a range of ports int (required)
startPort Starting port of a range of ports int (required)

VmssExtension

Name Description Value
name The name of the extension. string (required)
properties Describes the properties of a Virtual Machine Scale Set Extension. VmssExtensionProperties (required)

VmssExtensionProperties

Name Description Value
autoUpgradeMinorVersion 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. bool
forceUpdateTag 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. string
protectedSettings Any object For Bicep, you can use the any() function.
provisionAfterExtensions Collection of extension names after which this extension needs to be provisioned. string[]
publisher The name of the extension handler publisher. string (required)
settings Any object For Bicep, you can use the any() function.
type Specifies the type of the extension; an example is "CustomScriptExtension". string (required)
typeHandlerVersion Specifies the version of the script handler. string (required)

VmManagedIdentity

Name Description Value
userAssignedIdentities 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}'. string[]

VaultSecretGroup

Name Description Value
sourceVault Azure resource identifier. SubResource (required)
vaultCertificates The list of key vault references in SourceVault which contain certificates. VaultCertificate[] (required)

SubResource

Name Description Value
id Azure resource identifier. string

VaultCertificate

Name Description Value
certificateStore 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.
string (required)
certificateUrl 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. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}
string (required)