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

Bicep resource definition

The managedClusters/nodeTypes resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.ServiceFabric/managedClusters/nodeTypes@2020-01-01-preview' = {
  name: 'string'
  properties: {
    applicationPorts: {
      endPort: int
      startPort: int
    }
    capacities: {
      {customized property}: 'string'
    }
    dataDiskSizeGB: int
    ephemeralPorts: {
      endPort: int
      startPort: int
    }
    isPrimary: bool
    placementProperties: {
      {customized property}: 'string'
    }
    vmExtensions: [
      {
        name: 'string'
        properties: {
          autoUpgradeMinorVersion: bool
          forceUpdateTag: 'string'
          protectedSettings: any(Azure.Bicep.Types.Concrete.AnyType)
          provisionAfterExtensions: [
            'string'
          ]
          publisher: 'string'
          settings: any(Azure.Bicep.Types.Concrete.AnyType)
          type: 'string'
          typeHandlerVersion: 'string'
        }
      }
    ]
    vmImageOffer: 'string'
    vmImagePublisher: 'string'
    vmImageSku: 'string'
    vmImageVersion: 'string'
    vmInstanceCount: int
    vmSecrets: [
      {
        sourceVault: {
          id: 'string'
        }
        vaultCertificates: [
          {
            certificateStore: 'string'
            certificateUrl: 'string'
          }
        ]
      }
    ]
    vmSize: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

EndpointRangeDescription

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

ManagedProxyResourceTags

Name Description Value

Microsoft.ServiceFabric/managedClusters/nodeTypes

Name Description Value
name The resource name string (required)
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.
Symbolic name for resource of type: managedClusters
properties The node type properties NodeTypeProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

NodeTypeProperties

Name Description Value
applicationPorts The range of ports from which cluster assigned port to Service Fabric applications. 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. NodeTypePropertiesCapacities
dataDiskSizeGB Disk size for each vm in the node type in GBs. int (required)
ephemeralPorts The range of ephemeral ports that nodes in this node type should be configured with. 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. NodeTypePropertiesPlacementProperties
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

Constraints:
Min value = 1
Max value = 2147483647 (required)
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

NodeTypePropertiesCapacities

Name Description Value

NodeTypePropertiesPlacementProperties

Name Description Value

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)

VaultSecretGroup

Name Description Value
sourceVault The relative URL of the Key Vault containing all of the certificates in VaultCertificates. SubResource (required)
vaultCertificates The list of key vault references in SourceVault which contain certificates. VaultCertificate[] (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 The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. any
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 Json formatted public settings for the extension. any
type Specifies the type of the extension; an example is "CustomScriptExtension". string (required)
typeHandlerVersion Specifies the version of the script handler. string (required)

ARM template resource definition

The managedClusters/nodeTypes resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes",
  "apiVersion": "2020-01-01-preview",
  "name": "string",
  "properties": {
    "applicationPorts": {
      "endPort": "int",
      "startPort": "int"
    },
    "capacities": {
      "{customized property}": "string"
    },
    "dataDiskSizeGB": "int",
    "ephemeralPorts": {
      "endPort": "int",
      "startPort": "int"
    },
    "isPrimary": "bool",
    "placementProperties": {
      "{customized property}": "string"
    },
    "vmExtensions": [
      {
        "name": "string",
        "properties": {
          "autoUpgradeMinorVersion": "bool",
          "forceUpdateTag": "string",
          "protectedSettings": {},
          "provisionAfterExtensions": [ "string" ],
          "publisher": "string",
          "settings": {},
          "type": "string",
          "typeHandlerVersion": "string"
        }
      }
    ],
    "vmImageOffer": "string",
    "vmImagePublisher": "string",
    "vmImageSku": "string",
    "vmImageVersion": "string",
    "vmInstanceCount": "int",
    "vmSecrets": [
      {
        "sourceVault": {
          "id": "string"
        },
        "vaultCertificates": [
          {
            "certificateStore": "string",
            "certificateUrl": "string"
          }
        ]
      }
    ],
    "vmSize": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

EndpointRangeDescription

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

ManagedProxyResourceTags

Name Description Value

Microsoft.ServiceFabric/managedClusters/nodeTypes

Name Description Value
apiVersion The api version '2020-01-01-preview'
name The resource name string (required)
properties The node type properties NodeTypeProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ServiceFabric/managedClusters/nodeTypes'

NodeTypeProperties

Name Description Value
applicationPorts The range of ports from which cluster assigned port to Service Fabric applications. 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. NodeTypePropertiesCapacities
dataDiskSizeGB Disk size for each vm in the node type in GBs. int (required)
ephemeralPorts The range of ephemeral ports that nodes in this node type should be configured with. 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. NodeTypePropertiesPlacementProperties
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

Constraints:
Min value = 1
Max value = 2147483647 (required)
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

NodeTypePropertiesCapacities

Name Description Value

NodeTypePropertiesPlacementProperties

Name Description Value

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)

VaultSecretGroup

Name Description Value
sourceVault The relative URL of the Key Vault containing all of the certificates in VaultCertificates. SubResource (required)
vaultCertificates The list of key vault references in SourceVault which contain certificates. VaultCertificate[] (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 The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. any
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 Json formatted public settings for the extension. any
type Specifies the type of the extension; an example is "CustomScriptExtension". string (required)
typeHandlerVersion Specifies the version of the script handler. string (required)

Terraform (AzAPI provider) resource definition

The managedClusters/nodeTypes resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceFabric/managedClusters/nodeTypes@2020-01-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      applicationPorts = {
        endPort = int
        startPort = int
      }
      capacities = {
        {customized property} = "string"
      }
      dataDiskSizeGB = int
      ephemeralPorts = {
        endPort = int
        startPort = int
      }
      isPrimary = bool
      placementProperties = {
        {customized property} = "string"
      }
      vmExtensions = [
        {
          name = "string"
          properties = {
            autoUpgradeMinorVersion = bool
            forceUpdateTag = "string"
            protectedSettings = ?
            provisionAfterExtensions = [
              "string"
            ]
            publisher = "string"
            settings = ?
            type = "string"
            typeHandlerVersion = "string"
          }
        }
      ]
      vmImageOffer = "string"
      vmImagePublisher = "string"
      vmImageSku = "string"
      vmImageVersion = "string"
      vmInstanceCount = int
      vmSecrets = [
        {
          sourceVault = {
            id = "string"
          }
          vaultCertificates = [
            {
              certificateStore = "string"
              certificateUrl = "string"
            }
          ]
        }
      ]
      vmSize = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

EndpointRangeDescription

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

ManagedProxyResourceTags

Name Description Value

Microsoft.ServiceFabric/managedClusters/nodeTypes

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: managedClusters
properties The node type properties NodeTypeProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ServiceFabric/managedClusters/nodeTypes@2020-01-01-preview"

NodeTypeProperties

Name Description Value
applicationPorts The range of ports from which cluster assigned port to Service Fabric applications. 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. NodeTypePropertiesCapacities
dataDiskSizeGB Disk size for each vm in the node type in GBs. int (required)
ephemeralPorts The range of ephemeral ports that nodes in this node type should be configured with. 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. NodeTypePropertiesPlacementProperties
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

Constraints:
Min value = 1
Max value = 2147483647 (required)
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

NodeTypePropertiesCapacities

Name Description Value

NodeTypePropertiesPlacementProperties

Name Description Value

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)

VaultSecretGroup

Name Description Value
sourceVault The relative URL of the Key Vault containing all of the certificates in VaultCertificates. SubResource (required)
vaultCertificates The list of key vault references in SourceVault which contain certificates. VaultCertificate[] (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 The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. any
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 Json formatted public settings for the extension. any
type Specifies the type of the extension; an example is "CustomScriptExtension". string (required)
typeHandlerVersion Specifies the version of the script handler. string (required)