Microsoft.ServiceFabric (preview:2024-11-01)

2025/09/25 • 1 new, 4 updated methods

Applications_UpdateUpgrade (new)
Description :  Send a request to update the current application upgrade.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}/updateUpgrade
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for updating an application upgrade. ,
Required: True ,
}
{
name:
{
Description: The name of the application, including the 'fabric:' URI scheme. ,
Required: True ,
}
string ,
upgradeKind:
{
Description: The kind of the upgrade. ,
Enum:
{
Rolling: The upgrade progresses one upgrade domain at a time. ,
}
,
Required: True ,
}
enum ,
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
considerWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: True ,
}
boolean ,
maxPercentUnhealthyDeployedApplications:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum allowed percentage of unhealthy services. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum allowed percentage of unhealthy partitions per service. The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum allowed percentage of unhealthy replicas per partition. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
updateDescription:
{
Description: Describes the parameters for updating a rolling upgrade of application or cluster and a monitoring policy. ,
Required: False ,
}
{
rollingUpgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. ,
Enum:
{
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. ,
UnmonitoredManual: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. ,
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. ,
}
,
Required: True ,
}
enum ,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
replicaSetCheckTimeoutInMilliseconds:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
failureAction:
{
Description: The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: False ,
}
enum ,
healthCheckWaitDurationInMilliseconds:
{
Description: 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. ,
Required: False ,
}
string ,
healthCheckStableDurationInMilliseconds:
{
Description: 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. ,
Required: False ,
}
string ,
healthCheckRetryTimeoutInMilliseconds:
{
Description: 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. ,
Required: False ,
}
string ,
upgradeTimeoutInMilliseconds:
{
Description: 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. ,
Required: False ,
}
string ,
upgradeDomainTimeoutInMilliseconds:
{
Description: 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. ,
Required: False ,
}
string ,
instanceCloseDelayDurationInSeconds:
{
Description: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Applications_List (updated)
Description :  Gets all managed application resources created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Applications_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "upgradePolicy": [
                  {
                    "#name": "upgradeMode",
                    "Enum": {
                      "new": [
                        [
                          "Monitored",
                          "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding."
                        ],
                        [
                          "UnmonitoredAuto",
                          "The upgrade will proceed automatically without performing any health monitoring."
                        ]
                      ],
                      "old": [
                        [
                          "Monitored",
                          "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0."
                        ],
                        [
                          "UnmonitoredAuto",
                          "The upgrade will proceed automatically without performing any health monitoring. The value is 1."
                        ]
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ApplicationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
managedIdentities:
{
Description: List of user assigned identities for the application, each mapped to a friendly name. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name of user assigned identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal id of user assigned identity. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
version:
{
Description: The version of the application type as defined in the application manifest. This name must be the full Arm Resource ID for the referenced application type version. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
considerWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: True ,
}
boolean ,
maxPercentUnhealthyDeployedApplications:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum allowed percentage of unhealthy services. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum allowed percentage of unhealthy partitions per service. The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum allowed percentage of unhealthy replicas per partition. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: True ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
instanceCloseDelayDuration:
{
Description: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. ,
Format: int64 ,
Required: False ,
}
integer ,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. ,
Enum:
{
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. ,
}
,
Required: False ,
}
enum ,
upgradeReplicaSetCheckTimeout:
{
Description: 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). Unit is in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
recreateApplication:
{
Description: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. ,
Required: False ,
}
boolean ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Describes the managed identities for an Azure resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of managed identity for the resource. ,
Enum:
{
None: Indicates that no identity is associated with the resource. ,
SystemAssigned: Indicates that system assigned identity is associated with the resource. ,
UserAssigned: Indicates that user assigned identity is associated with the resource. ,
SystemAssigned, UserAssigned: Indicates that both system assigned and user assigned identity are associated with the resource. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Applications_Get (updated)
Description :  Get a Service Fabric managed application resource created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Applications_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "upgradePolicy": [
              {
                "#name": "upgradeMode",
                "Enum": {
                  "new": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring."
                    ]
                  ],
                  "old": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring. The value is 1."
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
managedIdentities:
{
Description: List of user assigned identities for the application, each mapped to a friendly name. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name of user assigned identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal id of user assigned identity. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
version:
{
Description: The version of the application type as defined in the application manifest. This name must be the full Arm Resource ID for the referenced application type version. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
considerWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: True ,
}
boolean ,
maxPercentUnhealthyDeployedApplications:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum allowed percentage of unhealthy services. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum allowed percentage of unhealthy partitions per service. The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum allowed percentage of unhealthy replicas per partition. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: True ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
instanceCloseDelayDuration:
{
Description: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. ,
Format: int64 ,
Required: False ,
}
integer ,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. ,
Enum:
{
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. ,
}
,
Required: False ,
}
enum ,
upgradeReplicaSetCheckTimeout:
{
Description: 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). Unit is in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
recreateApplication:
{
Description: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. ,
Required: False ,
}
boolean ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Describes the managed identities for an Azure resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of managed identity for the resource. ,
Enum:
{
None: Indicates that no identity is associated with the resource. ,
SystemAssigned: Indicates that system assigned identity is associated with the resource. ,
UserAssigned: Indicates that user assigned identity is associated with the resource. ,
SystemAssigned, UserAssigned: Indicates that both system assigned and user assigned identity are associated with the resource. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Applications_CreateOrUpdate (updated)
Description :  Create or update a Service Fabric managed application resource with the specified name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Applications_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "upgradePolicy": [
              {
                "#name": "upgradeMode",
                "Enum": {
                  "new": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring."
                    ]
                  ],
                  "old": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring. The value is 1."
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "upgradePolicy": [
              {
                "#name": "upgradeMode",
                "Enum": {
                  "new": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring."
                    ]
                  ],
                  "old": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring. The value is 1."
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "upgradePolicy": [
              {
                "#name": "upgradeMode",
                "Enum": {
                  "new": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring."
                    ]
                  ],
                  "old": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring. The value is 1."
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource. ,
Required: True ,
}
{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
managedIdentities:
{
Description: List of user assigned identities for the application, each mapped to a friendly name. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name of user assigned identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal id of user assigned identity. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
version:
{
Description: The version of the application type as defined in the application manifest. This name must be the full Arm Resource ID for the referenced application type version. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
considerWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: True ,
}
boolean ,
maxPercentUnhealthyDeployedApplications:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum allowed percentage of unhealthy services. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum allowed percentage of unhealthy partitions per service. The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum allowed percentage of unhealthy replicas per partition. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: True ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
instanceCloseDelayDuration:
{
Description: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. ,
Format: int64 ,
Required: False ,
}
integer ,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. ,
Enum:
{
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. ,
}
,
Required: False ,
}
enum ,
upgradeReplicaSetCheckTimeout:
{
Description: 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). Unit is in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
recreateApplication:
{
Description: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. ,
Required: False ,
}
boolean ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Describes the managed identities for an Azure resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of managed identity for the resource. ,
Enum:
{
None: Indicates that no identity is associated with the resource. ,
SystemAssigned: Indicates that system assigned identity is associated with the resource. ,
UserAssigned: Indicates that user assigned identity is associated with the resource. ,
SystemAssigned, UserAssigned: Indicates that both system assigned and user assigned identity are associated with the resource. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
managedIdentities:
{
Description: List of user assigned identities for the application, each mapped to a friendly name. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name of user assigned identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal id of user assigned identity. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
version:
{
Description: The version of the application type as defined in the application manifest. This name must be the full Arm Resource ID for the referenced application type version. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
considerWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: True ,
}
boolean ,
maxPercentUnhealthyDeployedApplications:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum allowed percentage of unhealthy services. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum allowed percentage of unhealthy partitions per service. The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum allowed percentage of unhealthy replicas per partition. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: True ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
instanceCloseDelayDuration:
{
Description: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. ,
Format: int64 ,
Required: False ,
}
integer ,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. ,
Enum:
{
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. ,
}
,
Required: False ,
}
enum ,
upgradeReplicaSetCheckTimeout:
{
Description: 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). Unit is in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
recreateApplication:
{
Description: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. ,
Required: False ,
}
boolean ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Describes the managed identities for an Azure resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of managed identity for the resource. ,
Enum:
{
None: Indicates that no identity is associated with the resource. ,
SystemAssigned: Indicates that system assigned identity is associated with the resource. ,
UserAssigned: Indicates that user assigned identity is associated with the resource. ,
SystemAssigned, UserAssigned: Indicates that both system assigned and user assigned identity are associated with the resource. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: The application resource. ,
}
{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
managedIdentities:
{
Description: List of user assigned identities for the application, each mapped to a friendly name. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name of user assigned identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal id of user assigned identity. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
version:
{
Description: The version of the application type as defined in the application manifest. This name must be the full Arm Resource ID for the referenced application type version. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
considerWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: True ,
}
boolean ,
maxPercentUnhealthyDeployedApplications:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum allowed percentage of unhealthy services. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum allowed percentage of unhealthy partitions per service. The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum allowed percentage of unhealthy replicas per partition. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: True ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
instanceCloseDelayDuration:
{
Description: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. ,
Format: int64 ,
Required: False ,
}
integer ,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. ,
Enum:
{
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. ,
}
,
Required: False ,
}
enum ,
upgradeReplicaSetCheckTimeout:
{
Description: 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). Unit is in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
recreateApplication:
{
Description: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. ,
Required: False ,
}
boolean ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Describes the managed identities for an Azure resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of managed identity for the resource. ,
Enum:
{
None: Indicates that no identity is associated with the resource. ,
SystemAssigned: Indicates that system assigned identity is associated with the resource. ,
UserAssigned: Indicates that user assigned identity is associated with the resource. ,
SystemAssigned, UserAssigned: Indicates that both system assigned and user assigned identity are associated with the resource. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Applications_Update (updated)
Description :  Updates the tags of an application resource of a given managed cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Applications_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "upgradePolicy": [
              {
                "#name": "upgradeMode",
                "Enum": {
                  "new": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring."
                    ]
                  ],
                  "old": [
                    [
                      "Monitored",
                      "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0."
                    ],
                    [
                      "UnmonitoredAuto",
                      "The upgrade will proceed automatically without performing any health monitoring. The value is 1."
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource updated tags. ,
Required: True ,
}
{
tags:
{
Description: Application update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
managedIdentities:
{
Description: List of user assigned identities for the application, each mapped to a friendly name. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name of user assigned identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal id of user assigned identity. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
version:
{
Description: The version of the application type as defined in the application manifest. This name must be the full Arm Resource ID for the referenced application type version. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
considerWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: True ,
}
boolean ,
maxPercentUnhealthyDeployedApplications:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum allowed percentage of unhealthy services. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum allowed percentage of unhealthy partitions per service. The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum allowed percentage of unhealthy replicas per partition. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: True ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
instanceCloseDelayDuration:
{
Description: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. ,
Format: int64 ,
Required: False ,
}
integer ,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. ,
Enum:
{
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. ,
}
,
Required: False ,
}
enum ,
upgradeReplicaSetCheckTimeout:
{
Description: 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). Unit is in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
recreateApplication:
{
Description: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. ,
Required: False ,
}
boolean ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Describes the managed identities for an Azure resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of managed identity for the resource. ,
Enum:
{
None: Indicates that no identity is associated with the resource. ,
SystemAssigned: Indicates that system assigned identity is associated with the resource. ,
UserAssigned: Indicates that user assigned identity is associated with the resource. ,
SystemAssigned, UserAssigned: Indicates that both system assigned and user assigned identity are associated with the resource. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}