Microsoft.ServiceFabric managedclusters/applications/services 2023-11-01-preview

Article
10/25/2024

Bicep resource definition

The managedclusters/applications/services resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

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

Resource format

To create a Microsoft.ServiceFabric/managedclusters/applications/services resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ServiceFabric/managedclusters/applications/services@2023-11-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    correlationScheme: [
      {
        scheme: 'string'
        serviceName: 'string'
      }
    ]
    defaultMoveCost: 'string'
    partitionDescription: {
      partitionScheme: 'string'
      // For remaining properties, see Partition objects
    }
    placementConstraints: 'string'
    scalingPolicies: [
      {
        scalingMechanism: {
          kind: 'string'
          // For remaining properties, see ScalingMechanism objects
        }
        scalingTrigger: {
          kind: 'string'
          // For remaining properties, see ScalingTrigger objects
        }
      }
    ]
    serviceDnsName: 'string'
    serviceLoadMetrics: [
      {
        defaultLoad: int
        name: 'string'
        primaryDefaultLoad: int
        secondaryDefaultLoad: int
        weight: 'string'
      }
    ]
    servicePackageActivationMode: 'string'
    servicePlacementPolicies: [
      {
        type: 'string'
        // For remaining properties, see ServicePlacementPolicy objects
      }
    ]
    serviceTypeName: 'string'
    serviceKind: 'string'
    // For remaining properties, see ServiceResourceProperties objects
  }
  tags: {
    {customized property}: 'string'
  }
}

ScalingTrigger objects

Set the kind property to specify the type of object.

For AveragePartitionLoadTrigger, use:

{
  kind: 'AveragePartitionLoadTrigger'
  lowerLoadThreshold: int
  metricName: 'string'
  scaleInterval: 'string'
  upperLoadThreshold: int
}

For AverageServiceLoadTrigger, use:

{
  kind: 'AverageServiceLoadTrigger'
  lowerLoadThreshold: int
  metricName: 'string'
  scaleInterval: 'string'
  upperLoadThreshold: int
  useOnlyPrimaryLoad: bool
}

ServicePlacementPolicy objects

Set the type property to specify the type of object.

For InvalidDomain, use:

{
  domainName: 'string'
  type: 'InvalidDomain'
}

For NonPartiallyPlaceService, use:

{
  type: 'NonPartiallyPlaceService'
}

For PreferredPrimaryDomain, use:

{
  domainName: 'string'
  type: 'PreferredPrimaryDomain'
}

For RequiredDomain, use:

{
  domainName: 'string'
  type: 'RequiredDomain'
}

For RequiredDomainDistribution, use:

{
  domainName: 'string'
  type: 'RequiredDomainDistribution'
}

ScalingMechanism objects

Set the kind property to specify the type of object.

For AddRemoveIncrementalNamedPartition, use:

{
  kind: 'AddRemoveIncrementalNamedPartition'
  maxPartitionCount: int
  minPartitionCount: int
  scaleIncrement: int
}

For ScalePartitionInstanceCount, use:

{
  kind: 'ScalePartitionInstanceCount'
  maxInstanceCount: int
  minInstanceCount: int
  scaleIncrement: int
}

Partition objects

Set the partitionScheme property to specify the type of object.

For Named, use:

{
  names: [
    'string'
  ]
  partitionScheme: 'Named'
}

For Singleton, use:

{
  partitionScheme: 'Singleton'
}

For UniformInt64Range, use:

{
  count: int
  highKey: int
  lowKey: int
  partitionScheme: 'UniformInt64Range'
}

ServiceResourceProperties objects

Set the serviceKind property to specify the type of object.

For Stateful, use:

{
  hasPersistedState: bool
  minReplicaSetSize: int
  quorumLossWaitDuration: 'string'
  replicaRestartWaitDuration: 'string'
  serviceKind: 'Stateful'
  servicePlacementTimeLimit: 'string'
  standByReplicaKeepDuration: 'string'
  targetReplicaSetSize: int
}

For Stateless, use:

{
  instanceCount: int
  minInstanceCount: int
  minInstancePercentage: int
  serviceKind: 'Stateless'
}

Property values

AddRemoveIncrementalNamedPartitionScalingMechanism

Name	Description	Value
kind	Specifies the mechanism associated with this scaling policy.	'AddRemoveIncrementalNamedPartition' (required)
maxPartitionCount	Maximum number of named partitions of the service.	int (required)
minPartitionCount	Minimum number of named partitions of the service.	int (required)
scaleIncrement	The number of instances to add or remove during a scaling operation.	int (required)

AveragePartitionLoadScalingTrigger

Name	Description	Value
kind	Specifies the trigger associated with this scaling policy.	'AveragePartitionLoadTrigger' (required)
lowerLoadThreshold	The lower limit of the load below which a scale in operation should be performed.	int (required)
metricName	The name of the metric for which usage should be tracked.	string (required)
scaleInterval	The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format "hh:mm:ss".	string (required)
upperLoadThreshold	The upper limit of the load beyond which a scale out operation should be performed.	int (required)

AverageServiceLoadScalingTrigger

Name	Description	Value
kind	Specifies the trigger associated with this scaling policy.	'AverageServiceLoadTrigger' (required)
lowerLoadThreshold	The lower limit of the load below which a scale in operation should be performed.	int (required)
metricName	The name of the metric for which usage should be tracked.	string (required)
scaleInterval	The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format "hh:mm:ss".	string (required)
upperLoadThreshold	The upper limit of the load beyond which a scale out operation should be performed.	int (required)
useOnlyPrimaryLoad	Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service.	bool (required)