Share via

Microsoft.ServiceFabric managedClusters 2020-01-01-preview

  • Article

Bicep resource definition

The managedClusters 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 resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ServiceFabric/managedClusters@2020-01-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    addonFeatures: [
      'string'
    ]
    adminPassword: 'string'
    adminUserName: 'string'
    azureActiveDirectory: {
      clientApplication: 'string'
      clusterApplication: 'string'
      tenantId: 'string'
    }
    clientConnectionPort: int
    clients: [
      {
        commonName: 'string'
        isAdmin: bool
        issuerThumbprint: 'string'
        thumbprint: 'string'
      }
    ]
    clusterCodeVersion: 'string'
    dnsName: 'string'
    fabricSettings: [
      {
        name: 'string'
        parameters: [
          {
            name: 'string'
            value: 'string'
          }
        ]
      }
    ]
    httpGatewayConnectionPort: int
    loadBalancingRules: [
      {
        backendPort: int
        frontendPort: int
        probeProtocol: 'string'
        probeRequestPath: 'string'
        protocol: 'string'
      }
    ]
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AzureActiveDirectory

Name Description Value
clientApplication Azure active directory client application id. string
clusterApplication Azure active directory cluster application id. string
tenantId Azure active directory tenant id. string

ClientCertificate

Name Description Value
commonName Certificate Common name. string
isAdmin Whether the certificate is admin or not. bool (required)
issuerThumbprint Issuer thumbprint for the certificate. Only used together with CommonName. string
thumbprint Certificate Thumbprint. string

LoadBalancingRule

Name Description Value
backendPort The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. int

Constraints:
Min value = 1
Max value = 65534 (required)
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. int

Constraints:
Min value = 1
Max value = 65534 (required)
probeProtocol the reference to the load balancer probe used by the load balancing rule. 'http'
'https'
'tcp' (required)
probeRequestPath The probe request path. Only supported for HTTP/HTTPS probes. string
protocol The reference to the transport protocol used by the load balancing rule. 'tcp'
'udp' (required)

ManagedClusterProperties

Name Description Value
addonFeatures client certificates for the cluster. String array containing any of:
'BackupRestoreService'
'DnsService'
'ResourceMonitorService'
adminPassword vm admin user password. string

Constraints:
Sensitive value. Pass in as a secure parameter.
adminUserName vm admin user name. string (required)
azureActiveDirectory Azure active directory. AzureActiveDirectory
clientConnectionPort The port used for client connections to the cluster. int
clients client certificates for the cluster. ClientCertificate[]
clusterCodeVersion The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions. string
dnsName The cluster dns name. string (required)
fabricSettings The list of custom fabric settings to configure the cluster. SettingsSectionDescription[]
httpGatewayConnectionPort The port used for http connections to the cluster. int
loadBalancingRules Describes load balancing rules. LoadBalancingRule[]

Microsoft.ServiceFabric/managedClusters

Name Description Value
location Azure resource location. string (required)
name The resource name string (required)
properties The managed cluster resource properties ManagedClusterProperties
sku The sku of the managed cluster Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

SettingsParameterDescription

Name Description Value
name The parameter name of fabric setting. string (required)
value The parameter value of fabric setting. string (required)

SettingsSectionDescription

Name Description Value
name The section name of the fabric settings. string (required)
parameters The collection of parameters in the section. SettingsParameterDescription[] (required)

Sku

Name Description Value
name Sku Name. 'Basic'
'Standard' (required)

ARM template resource definition

The managedClusters 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 resource, add the following JSON to your template.

{
  "type": "Microsoft.ServiceFabric/managedClusters",
  "apiVersion": "2020-01-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "addonFeatures": [ "string" ],
    "adminPassword": "string",
    "adminUserName": "string",
    "azureActiveDirectory": {
      "clientApplication": "string",
      "clusterApplication": "string",
      "tenantId": "string"
    },
    "clientConnectionPort": "int",
    "clients": [
      {
        "commonName": "string",
        "isAdmin": "bool",
        "issuerThumbprint": "string",
        "thumbprint": "string"
      }
    ],
    "clusterCodeVersion": "string",
    "dnsName": "string",
    "fabricSettings": [
      {
        "name": "string",
        "parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "httpGatewayConnectionPort": "int",
    "loadBalancingRules": [
      {
        "backendPort": "int",
        "frontendPort": "int",
        "probeProtocol": "string",
        "probeRequestPath": "string",
        "protocol": "string"
      }
    ]
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AzureActiveDirectory

Name Description Value
clientApplication Azure active directory client application id. string
clusterApplication Azure active directory cluster application id. string
tenantId Azure active directory tenant id. string

ClientCertificate

Name Description Value
commonName Certificate Common name. string
isAdmin Whether the certificate is admin or not. bool (required)
issuerThumbprint Issuer thumbprint for the certificate. Only used together with CommonName. string
thumbprint Certificate Thumbprint. string

LoadBalancingRule

Name Description Value
backendPort The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. int

Constraints:
Min value = 1
Max value = 65534 (required)
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. int

Constraints:
Min value = 1
Max value = 65534 (required)
probeProtocol the reference to the load balancer probe used by the load balancing rule. 'http'
'https'
'tcp' (required)
probeRequestPath The probe request path. Only supported for HTTP/HTTPS probes. string
protocol The reference to the transport protocol used by the load balancing rule. 'tcp'
'udp' (required)

ManagedClusterProperties

Name Description Value
addonFeatures client certificates for the cluster. String array containing any of:
'BackupRestoreService'
'DnsService'
'ResourceMonitorService'
adminPassword vm admin user password. string

Constraints:
Sensitive value. Pass in as a secure parameter.
adminUserName vm admin user name. string (required)
azureActiveDirectory Azure active directory. AzureActiveDirectory
clientConnectionPort The port used for client connections to the cluster. int
clients client certificates for the cluster. ClientCertificate[]
clusterCodeVersion The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions. string
dnsName The cluster dns name. string (required)
fabricSettings The list of custom fabric settings to configure the cluster. SettingsSectionDescription[]
httpGatewayConnectionPort The port used for http connections to the cluster. int
loadBalancingRules Describes load balancing rules. LoadBalancingRule[]

Microsoft.ServiceFabric/managedClusters

Name Description Value
apiVersion The api version '2020-01-01-preview'
location Azure resource location. string (required)
name The resource name string (required)
properties The managed cluster resource properties ManagedClusterProperties
sku The sku of the managed cluster Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ServiceFabric/managedClusters'

ResourceTags

Name Description Value

SettingsParameterDescription

Name Description Value
name The parameter name of fabric setting. string (required)
value The parameter value of fabric setting. string (required)

SettingsSectionDescription

Name Description Value
name The section name of the fabric settings. string (required)
parameters The collection of parameters in the section. SettingsParameterDescription[] (required)

Sku

Name Description Value
name Sku Name. 'Basic'
'Standard' (required)

Terraform (AzAPI provider) resource definition

The managedClusters 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceFabric/managedClusters@2020-01-01-preview"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      addonFeatures = [
        "string"
      ]
      adminPassword = "string"
      adminUserName = "string"
      azureActiveDirectory = {
        clientApplication = "string"
        clusterApplication = "string"
        tenantId = "string"
      }
      clientConnectionPort = int
      clients = [
        {
          commonName = "string"
          isAdmin = bool
          issuerThumbprint = "string"
          thumbprint = "string"
        }
      ]
      clusterCodeVersion = "string"
      dnsName = "string"
      fabricSettings = [
        {
          name = "string"
          parameters = [
            {
              name = "string"
              value = "string"
            }
          ]
        }
      ]
      httpGatewayConnectionPort = int
      loadBalancingRules = [
        {
          backendPort = int
          frontendPort = int
          probeProtocol = "string"
          probeRequestPath = "string"
          protocol = "string"
        }
      ]
    }
  })
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Property values

AzureActiveDirectory

Name Description Value
clientApplication Azure active directory client application id. string
clusterApplication Azure active directory cluster application id. string
tenantId Azure active directory tenant id. string

ClientCertificate

Name Description Value
commonName Certificate Common name. string
isAdmin Whether the certificate is admin or not. bool (required)
issuerThumbprint Issuer thumbprint for the certificate. Only used together with CommonName. string
thumbprint Certificate Thumbprint. string

LoadBalancingRule

Name Description Value
backendPort The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. int

Constraints:
Min value = 1
Max value = 65534 (required)
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. int

Constraints:
Min value = 1
Max value = 65534 (required)
probeProtocol the reference to the load balancer probe used by the load balancing rule. 'http'
'https'
'tcp' (required)
probeRequestPath The probe request path. Only supported for HTTP/HTTPS probes. string
protocol The reference to the transport protocol used by the load balancing rule. 'tcp'
'udp' (required)

ManagedClusterProperties

Name Description Value
addonFeatures client certificates for the cluster. String array containing any of:
'BackupRestoreService'
'DnsService'
'ResourceMonitorService'
adminPassword vm admin user password. string

Constraints:
Sensitive value. Pass in as a secure parameter.
adminUserName vm admin user name. string (required)
azureActiveDirectory Azure active directory. AzureActiveDirectory
clientConnectionPort The port used for client connections to the cluster. int
clients client certificates for the cluster. ClientCertificate[]
clusterCodeVersion The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions. string
dnsName The cluster dns name. string (required)
fabricSettings The list of custom fabric settings to configure the cluster. SettingsSectionDescription[]
httpGatewayConnectionPort The port used for http connections to the cluster. int
loadBalancingRules Describes load balancing rules. LoadBalancingRule[]

Microsoft.ServiceFabric/managedClusters

Name Description Value
location Azure resource location. string (required)
name The resource name string (required)
properties The managed cluster resource properties ManagedClusterProperties
sku The sku of the managed cluster Sku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ServiceFabric/managedClusters@2020-01-01-preview"

ResourceTags

Name Description Value

SettingsParameterDescription

Name Description Value
name The parameter name of fabric setting. string (required)
value The parameter value of fabric setting. string (required)

SettingsSectionDescription

Name Description Value
name The section name of the fabric settings. string (required)
parameters The collection of parameters in the section. SettingsParameterDescription[] (required)

Sku

Name Description Value
name Sku Name. 'Basic'
'Standard' (required)