Microsoft.ServiceFabric clusters/applications 2020-12-01-preview
Bicep resource definition
The clusters/applications 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/clusters/applications resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ServiceFabric/clusters/applications@2020-12-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
managedIdentities: [
{
name: 'string'
principalId: 'string'
}
]
maximumNodes: int
metrics: [
{
maximumCapacity: int
name: 'string'
reservationCapacity: int
totalApplicationCapacity: int
}
]
minimumNodes: int
parameters: {
{customized property}: 'string'
}
removeApplicationCapacity: bool
typeName: 'string'
typeVersion: 'string'
upgradePolicy: {
applicationHealthPolicy: {
considerWarningAsError: bool
defaultServiceTypeHealthPolicy: {
maxPercentUnhealthyPartitionsPerService: int
maxPercentUnhealthyReplicasPerPartition: int
maxPercentUnhealthyServices: int
}
maxPercentUnhealthyDeployedApplications: int
serviceTypeHealthPolicyMap: {
{customized property}: {
maxPercentUnhealthyPartitionsPerService: int
maxPercentUnhealthyReplicasPerPartition: int
maxPercentUnhealthyServices: int
}
}
}
forceRestart: bool
recreateApplication: bool
rollingUpgradeMonitoringPolicy: {
failureAction: 'string'
healthCheckRetryTimeout: 'string'
healthCheckStableDuration: 'string'
healthCheckWaitDuration: 'string'
upgradeDomainTimeout: 'string'
upgradeTimeout: 'string'
}
upgradeMode: 'string'
upgradeReplicaSetCheckTimeout: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property values
ApplicationMetricDescription
| Name | Description | Value |
|---|---|---|
| maximumCapacity | The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. |
int |
| name | The name of the metric. | string |
| reservationCapacity | The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric. |
int |
| totalApplicationCapacity | The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value. |
int |
ApplicationParameterList
| Name | Description | Value |
|---|
ApplicationResourceProperties
| Name | Description | Value |
|---|---|---|
| managedIdentities | List of user assigned identities for the application, each mapped to a friendly name. | ApplicationUserAssignedIdentity[] |
| maximumNodes | The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. | int Constraints: Min value = 0 |
| metrics | List of application capacity metric description. | ApplicationMetricDescription[] |
| minimumNodes | The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property. | int Constraints: Min value = 0 |
| parameters | List of application parameters with overridden values from their default values specified in the application manifest. | ApplicationParameterList |
| removeApplicationCapacity | Remove the current application capacity settings. | bool |
| typeName | The application type name as defined in the application manifest. | string |
| typeVersion | The version of the application type as defined in the application manifest. | string |
| upgradePolicy | Describes the policy for a monitored application upgrade. | ApplicationUpgradePolicy |
ApplicationUpgradePolicy
| Name | Description | Value |
|---|---|---|
| applicationHealthPolicy | Defines a health policy used to evaluate the health of an application or one of its children entities. | ArmApplicationHealthPolicy |
| forceRestart | If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). | bool |
| recreateApplication | Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. | bool |
| rollingUpgradeMonitoringPolicy | The policy used for monitoring the application upgrade | ArmRollingUpgradeMonitoringPolicy |
| upgradeMode | The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. | 'Invalid' 'Monitored' 'UnmonitoredAuto' 'UnmonitoredManual' |
| upgradeReplicaSetCheckTimeout | The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). | string |
ApplicationUserAssignedIdentity
| Name | Description | Value |
|---|---|---|
| name | The friendly name of user assigned identity. | string (required) |
| principalId | The principal id of user assigned identity. | string (required) |
ArmApplicationHealthPolicy
| Name | Description | Value |
|---|---|---|
| considerWarningAsError | Indicates whether warnings are treated with the same severity as errors. | bool |
| defaultServiceTypeHealthPolicy | The health policy used by default to evaluate the health of a service type. | ArmServiceTypeHealthPolicy |
| maxPercentUnhealthyDeployedApplications | The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. |
int |
| serviceTypeHealthPolicyMap | The map with service type health policy per service type name. The map is empty by default. | ArmServiceTypeHealthPolicyMap |
ArmRollingUpgradeMonitoringPolicy
| Name | Description | Value |
|---|---|---|
| failureAction | The activation Mode of the service package | 'Manual' 'Rollback' |
| healthCheckRetryTimeout | The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| healthCheckStableDuration | The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| healthCheckWaitDuration | The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| upgradeDomainTimeout | The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| upgradeTimeout | The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
ArmServiceTypeHealthPolicy
| Name | Description | Value |
|---|---|---|
| maxPercentUnhealthyPartitionsPerService | The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. | int Constraints: Min value = 0 Max value = 100 |
| maxPercentUnhealthyReplicasPerPartition | The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. | int Constraints: Min value = 0 Max value = 100 |
| maxPercentUnhealthyServices | The maximum percentage of services allowed to be unhealthy before your application is considered in error. | int Constraints: Min value = 0 Max value = 100 |
ArmServiceTypeHealthPolicyMap
| Name | Description | Value |
|---|
ManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of managed identity for the resource. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
UserAssignedIdentityMap |
Microsoft.ServiceFabric/clusters/applications
| Name | Description | Value |
|---|---|---|
| identity | Describes the managed identities for an Azure resource. | ManagedIdentity |
| location | It will be deprecated in New API, resource location depends on the parent resource. | string |
| 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: clusters |
| properties | The application resource properties. | ApplicationResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ProxyResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserAssignedIdentityMap
| Name | Description | Value |
|---|
ARM template resource definition
The clusters/applications 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/clusters/applications resource, add the following JSON to your template.
{
"type": "Microsoft.ServiceFabric/clusters/applications",
"apiVersion": "2020-12-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"managedIdentities": [
{
"name": "string",
"principalId": "string"
}
],
"maximumNodes": "int",
"metrics": [
{
"maximumCapacity": "int",
"name": "string",
"reservationCapacity": "int",
"totalApplicationCapacity": "int"
}
],
"minimumNodes": "int",
"parameters": {
"{customized property}": "string"
},
"removeApplicationCapacity": "bool",
"typeName": "string",
"typeVersion": "string",
"upgradePolicy": {
"applicationHealthPolicy": {
"considerWarningAsError": "bool",
"defaultServiceTypeHealthPolicy": {
"maxPercentUnhealthyPartitionsPerService": "int",
"maxPercentUnhealthyReplicasPerPartition": "int",
"maxPercentUnhealthyServices": "int"
},
"maxPercentUnhealthyDeployedApplications": "int",
"serviceTypeHealthPolicyMap": {
"{customized property}": {
"maxPercentUnhealthyPartitionsPerService": "int",
"maxPercentUnhealthyReplicasPerPartition": "int",
"maxPercentUnhealthyServices": "int"
}
}
},
"forceRestart": "bool",
"recreateApplication": "bool",
"rollingUpgradeMonitoringPolicy": {
"failureAction": "string",
"healthCheckRetryTimeout": "string",
"healthCheckStableDuration": "string",
"healthCheckWaitDuration": "string",
"upgradeDomainTimeout": "string",
"upgradeTimeout": "string"
},
"upgradeMode": "string",
"upgradeReplicaSetCheckTimeout": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property values
ApplicationMetricDescription
| Name | Description | Value |
|---|---|---|
| maximumCapacity | The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. |
int |
| name | The name of the metric. | string |
| reservationCapacity | The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric. |
int |
| totalApplicationCapacity | The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value. |
int |
ApplicationParameterList
| Name | Description | Value |
|---|
ApplicationResourceProperties
| Name | Description | Value |
|---|---|---|
| managedIdentities | List of user assigned identities for the application, each mapped to a friendly name. | ApplicationUserAssignedIdentity[] |
| maximumNodes | The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. | int Constraints: Min value = 0 |
| metrics | List of application capacity metric description. | ApplicationMetricDescription[] |
| minimumNodes | The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property. | int Constraints: Min value = 0 |
| parameters | List of application parameters with overridden values from their default values specified in the application manifest. | ApplicationParameterList |
| removeApplicationCapacity | Remove the current application capacity settings. | bool |
| typeName | The application type name as defined in the application manifest. | string |
| typeVersion | The version of the application type as defined in the application manifest. | string |
| upgradePolicy | Describes the policy for a monitored application upgrade. | ApplicationUpgradePolicy |
ApplicationUpgradePolicy
| Name | Description | Value |
|---|---|---|
| applicationHealthPolicy | Defines a health policy used to evaluate the health of an application or one of its children entities. | ArmApplicationHealthPolicy |
| forceRestart | If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). | bool |
| recreateApplication | Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. | bool |
| rollingUpgradeMonitoringPolicy | The policy used for monitoring the application upgrade | ArmRollingUpgradeMonitoringPolicy |
| upgradeMode | The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. | 'Invalid' 'Monitored' 'UnmonitoredAuto' 'UnmonitoredManual' |
| upgradeReplicaSetCheckTimeout | The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). | string |
ApplicationUserAssignedIdentity
| Name | Description | Value |
|---|---|---|
| name | The friendly name of user assigned identity. | string (required) |
| principalId | The principal id of user assigned identity. | string (required) |
ArmApplicationHealthPolicy
| Name | Description | Value |
|---|---|---|
| considerWarningAsError | Indicates whether warnings are treated with the same severity as errors. | bool |
| defaultServiceTypeHealthPolicy | The health policy used by default to evaluate the health of a service type. | ArmServiceTypeHealthPolicy |
| maxPercentUnhealthyDeployedApplications | The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. |
int |
| serviceTypeHealthPolicyMap | The map with service type health policy per service type name. The map is empty by default. | ArmServiceTypeHealthPolicyMap |
ArmRollingUpgradeMonitoringPolicy
| Name | Description | Value |
|---|---|---|
| failureAction | The activation Mode of the service package | 'Manual' 'Rollback' |
| healthCheckRetryTimeout | The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| healthCheckStableDuration | The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| healthCheckWaitDuration | The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| upgradeDomainTimeout | The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| upgradeTimeout | The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
ArmServiceTypeHealthPolicy
| Name | Description | Value |
|---|---|---|
| maxPercentUnhealthyPartitionsPerService | The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. | int Constraints: Min value = 0 Max value = 100 |
| maxPercentUnhealthyReplicasPerPartition | The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. | int Constraints: Min value = 0 Max value = 100 |
| maxPercentUnhealthyServices | The maximum percentage of services allowed to be unhealthy before your application is considered in error. | int Constraints: Min value = 0 Max value = 100 |
ArmServiceTypeHealthPolicyMap
| Name | Description | Value |
|---|
ManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of managed identity for the resource. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
UserAssignedIdentityMap |
Microsoft.ServiceFabric/clusters/applications
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-12-01-preview' |
| identity | Describes the managed identities for an Azure resource. | ManagedIdentity |
| location | It will be deprecated in New API, resource location depends on the parent resource. | string |
| name | The resource name | string (required) |
| properties | The application resource properties. | ApplicationResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.ServiceFabric/clusters/applications' |
ProxyResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserAssignedIdentityMap
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The clusters/applications 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/clusters/applications resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceFabric/clusters/applications@2020-12-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
body = jsonencode({
properties = {
managedIdentities = [
{
name = "string"
principalId = "string"
}
]
maximumNodes = int
metrics = [
{
maximumCapacity = int
name = "string"
reservationCapacity = int
totalApplicationCapacity = int
}
]
minimumNodes = int
parameters = {
{customized property} = "string"
}
removeApplicationCapacity = bool
typeName = "string"
typeVersion = "string"
upgradePolicy = {
applicationHealthPolicy = {
considerWarningAsError = bool
defaultServiceTypeHealthPolicy = {
maxPercentUnhealthyPartitionsPerService = int
maxPercentUnhealthyReplicasPerPartition = int
maxPercentUnhealthyServices = int
}
maxPercentUnhealthyDeployedApplications = int
serviceTypeHealthPolicyMap = {
{customized property} = {
maxPercentUnhealthyPartitionsPerService = int
maxPercentUnhealthyReplicasPerPartition = int
maxPercentUnhealthyServices = int
}
}
}
forceRestart = bool
recreateApplication = bool
rollingUpgradeMonitoringPolicy = {
failureAction = "string"
healthCheckRetryTimeout = "string"
healthCheckStableDuration = "string"
healthCheckWaitDuration = "string"
upgradeDomainTimeout = "string"
upgradeTimeout = "string"
}
upgradeMode = "string"
upgradeReplicaSetCheckTimeout = "string"
}
}
})
tags = {
{customized property} = "string"
}
}
Property values
ApplicationMetricDescription
| Name | Description | Value |
|---|---|---|
| maximumCapacity | The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. |
int |
| name | The name of the metric. | string |
| reservationCapacity | The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric. |
int |
| totalApplicationCapacity | The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value. |
int |
ApplicationParameterList
| Name | Description | Value |
|---|
ApplicationResourceProperties
| Name | Description | Value |
|---|---|---|
| managedIdentities | List of user assigned identities for the application, each mapped to a friendly name. | ApplicationUserAssignedIdentity[] |
| maximumNodes | The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. | int Constraints: Min value = 0 |
| metrics | List of application capacity metric description. | ApplicationMetricDescription[] |
| minimumNodes | The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property. | int Constraints: Min value = 0 |
| parameters | List of application parameters with overridden values from their default values specified in the application manifest. | ApplicationParameterList |
| removeApplicationCapacity | Remove the current application capacity settings. | bool |
| typeName | The application type name as defined in the application manifest. | string |
| typeVersion | The version of the application type as defined in the application manifest. | string |
| upgradePolicy | Describes the policy for a monitored application upgrade. | ApplicationUpgradePolicy |
ApplicationUpgradePolicy
| Name | Description | Value |
|---|---|---|
| applicationHealthPolicy | Defines a health policy used to evaluate the health of an application or one of its children entities. | ArmApplicationHealthPolicy |
| forceRestart | If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). | bool |
| recreateApplication | Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. | bool |
| rollingUpgradeMonitoringPolicy | The policy used for monitoring the application upgrade | ArmRollingUpgradeMonitoringPolicy |
| upgradeMode | The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. | 'Invalid' 'Monitored' 'UnmonitoredAuto' 'UnmonitoredManual' |
| upgradeReplicaSetCheckTimeout | The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). | string |
ApplicationUserAssignedIdentity
| Name | Description | Value |
|---|---|---|
| name | The friendly name of user assigned identity. | string (required) |
| principalId | The principal id of user assigned identity. | string (required) |
ArmApplicationHealthPolicy
| Name | Description | Value |
|---|---|---|
| considerWarningAsError | Indicates whether warnings are treated with the same severity as errors. | bool |
| defaultServiceTypeHealthPolicy | The health policy used by default to evaluate the health of a service type. | ArmServiceTypeHealthPolicy |
| maxPercentUnhealthyDeployedApplications | The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. |
int |
| serviceTypeHealthPolicyMap | The map with service type health policy per service type name. The map is empty by default. | ArmServiceTypeHealthPolicyMap |
ArmRollingUpgradeMonitoringPolicy
| Name | Description | Value |
|---|---|---|
| failureAction | The activation Mode of the service package | 'Manual' 'Rollback' |
| healthCheckRetryTimeout | The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| healthCheckStableDuration | The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| healthCheckWaitDuration | The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| upgradeDomainTimeout | The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
| upgradeTimeout | The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. | string |
ArmServiceTypeHealthPolicy
| Name | Description | Value |
|---|---|---|
| maxPercentUnhealthyPartitionsPerService | The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. | int Constraints: Min value = 0 Max value = 100 |
| maxPercentUnhealthyReplicasPerPartition | The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. | int Constraints: Min value = 0 Max value = 100 |
| maxPercentUnhealthyServices | The maximum percentage of services allowed to be unhealthy before your application is considered in error. | int Constraints: Min value = 0 Max value = 100 |
ArmServiceTypeHealthPolicyMap
| Name | Description | Value |
|---|
ManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of managed identity for the resource. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
UserAssignedIdentityMap |
Microsoft.ServiceFabric/clusters/applications
| Name | Description | Value |
|---|---|---|
| identity | Describes the managed identities for an Azure resource. | ManagedIdentity |
| location | It will be deprecated in New API, resource location depends on the parent resource. | string |
| 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: clusters |
| properties | The application resource properties. | ApplicationResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.ServiceFabric/clusters/applications@2020-12-01-preview" |
ProxyResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserAssignedIdentityMap
| Name | Description | Value |
|---|