Microsoft.ServiceFabric (stable:2021-06-01)

2025/09/26 • 30 new, 30 deleted methods

ApplicationTypes_Get (new)
Description :  Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The application type name properties ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypes_CreateOrUpdate (new)
Description :  Create or update a Service Fabric application type name resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application type name resource. ,
Required: True ,
}
{
properties:
{
Description: The application type name properties ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The application type name properties ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypes_Delete (new)
Description :  Delete a Service Fabric application type name resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypes_List (new)
Description :  Gets all application type name resources created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The application type name properties ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of application type list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypeVersions_Get (new)
Description :  Get a Service Fabric application type version resource created or in the process of being created in the Service Fabric application type name resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the application type version resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
appPackageUrl:
{
Description: The URL to the application package ,
Required: True ,
}
string ,
defaultParameterList:
{
Description: List of application type parameters that can be overridden when creating or updating the application. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypeVersions_CreateOrUpdate (new)
Description :  Create or update a Service Fabric application type version resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application type version resource. ,
Required: True ,
}
{
properties:
{
Description: The properties of the application type version resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
appPackageUrl:
{
Description: The URL to the application package ,
Required: True ,
}
string ,
defaultParameterList:
{
Description: List of application type parameters that can be overridden when creating or updating the application. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The properties of the application type version resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
appPackageUrl:
{
Description: The URL to the application package ,
Required: True ,
}
string ,
defaultParameterList:
{
Description: List of application type parameters that can be overridden when creating or updating the application. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypeVersions_Delete (new)
Description :  Delete a Service Fabric application type version resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypeVersions_List (new)
Description :  Gets all application type version resources created or in the process of being created in the Service Fabric application type name resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The properties of the application type version resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
appPackageUrl:
{
Description: The URL to the application package ,
Required: True ,
}
string ,
defaultParameterList:
{
Description: List of application type parameters that can be overridden when creating or updating the application. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of application type version list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_Get (new)
Description :  Get a Service Fabric application resource created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_CreateOrUpdate (new)
Description :  Create or update a Service Fabric application resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource. ,
Required: True ,
}
{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_Update (new)
Description :  Update a Service Fabric application resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource for patch operations. ,
Required: True ,
}
{
properties:
{
Description: The application resource properties for patch operations. ,
Required: False ,
}
{
typeVersion:
{
Description: The version of the application type as defined in the application manifest. ,
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 ,
}
{
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). ,
Required: False ,
}
string ,
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 activation Mode of the service package ,
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 ,
healthCheckWaitDuration:
{
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 ,
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 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 ,
healthCheckRetryTimeout:
{
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 ,
upgradeTimeout:
{
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 ,
upgradeDomainTimeout:
{
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 ,
}
,
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: False ,
}
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: False ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum percentage of services allowed to be unhealthy before your application is considered in error. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. ,
Enum:
{
Invalid: Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. The value is 1 ,
UnmonitoredManual: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2 ,
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3 ,
}
,
Required: False ,
}
enum ,
recreateApplication:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
minimumNodes:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNodes:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
removeApplicationCapacity:
{
Description: Remove the current application capacity settings. ,
Required: False ,
}
boolean ,
metrics:
{
Description: List of application capacity metric description. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
maximumCapacity:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
reservationCapacity:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCapacity:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_Delete (new)
Description :  Delete a Service Fabric application resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_List (new)
Description :  Gets all application resources created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of application list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_Get (new)
Description :  Get a Service Fabric service resource created or in the process of being created in the Service Fabric application resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_CreateOrUpdate (new)
Description :  Create or update a Service Fabric service resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The service resource. ,
Required: True ,
}
{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_Update (new)
Description :  Update a Service Fabric service resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The service resource for patch operations. ,
Required: True ,
}
{
properties:
{
Description: The service resource properties for patch operations. ,
Required: False ,
}
{
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_Delete (new)
Description :  Delete a Service Fabric service resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_List (new)
Description :  Gets all service resources created or in the process of being created in the Service Fabric application resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of service list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_Get (new)
Description :  Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_CreateOrUpdate (new)
Description :  Create or update a Service Fabric cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster resource. ,
Required: True ,
}
{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_Update (new)
Description :  Update the configuration of a Service Fabric cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters which contains the property value and property name which used to update the cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: Describes the cluster resource properties that can be updated during PATCH operation. ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
nodeTypes:
{
Description: The list of node types in the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: The start timestamp to pause runtime version upgrades on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: The end timestamp of pause runtime version upgrades on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
tags:
{
Description: Cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_Delete (new)
Description :  Delete a Service Fabric cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_ListByResourceGroup (new)
Description :  Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_List (new)
Description :  Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters
{
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ClusterVersions_Get (new)
Description :  Gets information about an available Service Fabric cluster code version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions/{clusterVersion}
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
clusterVersion:
{
Description: The cluster code version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ClusterVersions_GetByEnvironment (new)
Description :  Gets information about an available Service Fabric cluster code version by environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions/{clusterVersion}
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
environment:
{
Description: The operating system of the cluster. The default means all. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
clusterVersion:
{
Description: The cluster code version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ClusterVersions_List (new)
Description :  Gets all available code versions for Service Fabric cluster resources by location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ClusterVersions_ListByEnvironment (new)
Description :  Gets all available code versions for Service Fabric cluster resources by environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
environment:
{
Description: The operating system of the cluster. The default means all. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_ListUpgradableVersions (new)
Description :  If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/listUpgradableVersions
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
versionsDescription:
{
Description: The upgrade path description with target version. ,
Required: False ,
}
{
targetVersion:
{
Description: The target code version. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
supportedPath:
{
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Get the list of available Service Fabric resource provider API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceFabric/operations
{
api-version:
{
Description: The version of the Service Fabric resource provider API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Service Fabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the provider. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed ,
Required: False ,
}
string ,
operation:
{
Description: The operation that can be performed. ,
Required: False ,
}
string ,
description:
{
Description: Operation description ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin result ,
Required: False ,
}
string ,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypes_Get (removed)
Description :  Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The application type name properties ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypes_CreateOrUpdate (removed)
Description :  Create or update a Service Fabric application type name resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application type name resource. ,
Required: True ,
}
{
properties:
{
Description: The application type name properties ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The application type name properties ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypes_Delete (removed)
Description :  Delete a Service Fabric application type name resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypes_List (removed)
Description :  Gets all application type name resources created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The application type name properties ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of application type list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypeVersions_Get (removed)
Description :  Get a Service Fabric application type version resource created or in the process of being created in the Service Fabric application type name resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the application type version resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
appPackageUrl:
{
Description: The URL to the application package ,
Required: True ,
}
string ,
defaultParameterList:
{
Description: List of application type parameters that can be overridden when creating or updating the application. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypeVersions_CreateOrUpdate (removed)
Description :  Create or update a Service Fabric application type version resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application type version resource. ,
Required: True ,
}
{
properties:
{
Description: The properties of the application type version resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
appPackageUrl:
{
Description: The URL to the application package ,
Required: True ,
}
string ,
defaultParameterList:
{
Description: List of application type parameters that can be overridden when creating or updating the application. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The properties of the application type version resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
appPackageUrl:
{
Description: The URL to the application package ,
Required: True ,
}
string ,
defaultParameterList:
{
Description: List of application type parameters that can be overridden when creating or updating the application. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypeVersions_Delete (removed)
Description :  Delete a Service Fabric application type version resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ApplicationTypeVersions_List (removed)
Description :  Gets all application type version resources created or in the process of being created in the Service Fabric application type name resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The properties of the application type version resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
appPackageUrl:
{
Description: The URL to the application package ,
Required: True ,
}
string ,
defaultParameterList:
{
Description: List of application type parameters that can be overridden when creating or updating the application. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of application type version list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_Get (removed)
Description :  Get a Service Fabric application resource created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_CreateOrUpdate (removed)
Description :  Create or update a Service Fabric application resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource. ,
Required: True ,
}
{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_Update (removed)
Description :  Update a Service Fabric application resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource for patch operations. ,
Required: True ,
}
{
properties:
{
Description: The application resource properties for patch operations. ,
Required: False ,
}
{
typeVersion:
{
Description: The version of the application type as defined in the application manifest. ,
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 ,
}
{
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). ,
Required: False ,
}
string ,
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 activation Mode of the service package ,
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 ,
healthCheckWaitDuration:
{
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 ,
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 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 ,
healthCheckRetryTimeout:
{
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 ,
upgradeTimeout:
{
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 ,
upgradeDomainTimeout:
{
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 ,
}
,
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: False ,
}
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: False ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum percentage of services allowed to be unhealthy before your application is considered in error. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. ,
Enum:
{
Invalid: Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. The value is 1 ,
UnmonitoredManual: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2 ,
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3 ,
}
,
Required: False ,
}
enum ,
recreateApplication:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
minimumNodes:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNodes:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
removeApplicationCapacity:
{
Description: Remove the current application capacity settings. ,
Required: False ,
}
boolean ,
metrics:
{
Description: List of application capacity metric description. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
maximumCapacity:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
reservationCapacity:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCapacity:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_Delete (removed)
Description :  Delete a Service Fabric application resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_List (removed)
Description :  Gets all application resources created or in the process of being created in the Service Fabric cluster resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
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:
{
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. ,
None: Indicates that no identity is 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 ,
}
,
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of application list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_Get (removed)
Description :  Get a Service Fabric service resource created or in the process of being created in the Service Fabric application resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_CreateOrUpdate (removed)
Description :  Create or update a Service Fabric service resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The service resource. ,
Required: True ,
}
{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_Update (removed)
Description :  Update a Service Fabric service resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The service resource for patch operations. ,
Required: True ,
}
{
properties:
{
Description: The service resource properties for patch operations. ,
Required: False ,
}
{
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_Delete (removed)
Description :  Delete a Service Fabric service resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Services_List (removed)
Description :  Gets all service resources created or in the process of being created in the Service Fabric application resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
serviceDnsName:
{
Description: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of service list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_Get (removed)
Description :  Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_CreateOrUpdate (removed)
Description :  Create or update a Service Fabric cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster resource. ,
Required: True ,
}
{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_Update (removed)
Description :  Update the configuration of a Service Fabric cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters which contains the property value and property name which used to update the cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: Describes the cluster resource properties that can be updated during PATCH operation. ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
nodeTypes:
{
Description: The list of node types in the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: The start timestamp to pause runtime version upgrades on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: The end timestamp of pause runtime version upgrades on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
tags:
{
Description: Cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_Delete (removed)
Description :  Delete a Service Fabric cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_ListByResourceGroup (removed)
Description :  Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_List (removed)
Description :  Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters
{
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
availableClusterVersions:
{
Description: The Service Fabric runtime versions available for this cluster. ,
Required: False ,
}
[
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterEndpoint:
{
Description: The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - Ready - Indicates that the cluster is in a stable state. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticsStorageAccountConfig:
{
Description: The storage account information for storing Service Fabric diagnostic logs. ,
Required: False ,
}
{
storageAccountName:
{
Description: The Azure storage account name. ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: The protected diagnostics storage key name. ,
Required: True ,
}
string ,
protectedAccountKeyName2:
{
Description: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. ,
Required: False ,
}
string ,
blobEndpoint:
{
Description: The blob endpoint of the azure storage account. ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: The queue endpoint of the azure storage account. ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: The table endpoint of the azure storage account. ,
Required: True ,
}
string ,
}
,
eventStoreServiceEnabled:
{
Description: Indicates if the event store service is enabled. ,
Required: False ,
}
boolean ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
managementEndpoint:
{
Description: The http management endpoint of the cluster. ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types in the cluster. ,
Required: True ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Format: int32 ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. ,
Format: int32 ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Format: int32 ,
Required: False ,
}
integer ,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multipleAvailabilityZones:
{
Description: Indicates if the node type is enabled to support multiple zones. ,
Required: False ,
}
boolean ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the cluster resource. ,
Enum:
{
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reverseProxyCertificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
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 ,
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Format: int32 ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
vmImage:
{
Description: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
sfZonalUpgradeMode:
{
Description: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. ,
Enum:
{
Parallel: VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time. ,
Hierarchical: If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application. ,
}
,
Required: False ,
}
enum ,
vmssZonalUpgradeMode:
{
Description: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. ,
Enum:
{
Parallel: Updates will happen in all Availability Zones at once for the virtual machine scale sets. ,
Hierarchical: VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. ,
}
,
Required: False ,
}
enum ,
infrastructureServiceManager:
{
Description: Indicates if infrastructure service manager is enabled. ,
Required: False ,
}
boolean ,
upgradeWave:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
upgradePauseStartTimestampUtc:
{
Description: Indicates the start date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
upgradePauseEndTimestampUtc:
{
Description: Indicates the end date and time to pause automatic runtime version upgrades on the cluster for an specific period of time on the cluster (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
waveUpgradePaused:
{
Description: Boolean to pause automatic runtime version upgrades to the cluster. ,
Required: False ,
}
boolean ,
notifications:
{
Description: Indicates a list of notification channels for cluster events. ,
Required: False ,
}
[
{
isEnabled:
{
Description: Indicates if the notification is enabled. ,
Required: True ,
}
boolean ,
notificationCategory:
{
Description: The category of notification. ,
Enum:
{
WaveProgress: Notification will be regarding wave progress. ,
}
,
Required: True ,
}
enum ,
notificationLevel:
{
Description: The level of notification. ,
Enum:
{
Critical: Receive only critical notifications. ,
All: Receive all notifications. ,
}
,
Required: True ,
}
enum ,
notificationTargets:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
{
notificationChannel:
{
Description: The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. ,
Enum:
{
EmailUser: For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications. ,
EmailSubscription: For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications. ,
}
,
Required: True ,
}
enum ,
receivers:
{
Description: List of targets that subscribe to the notification. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ClusterVersions_Get (removed)
Description :  Gets information about an available Service Fabric cluster code version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions/{clusterVersion}
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
clusterVersion:
{
Description: The cluster code version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ClusterVersions_GetByEnvironment (removed)
Description :  Gets information about an available Service Fabric cluster code version by environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions/{clusterVersion}
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
environment:
{
Description: The operating system of the cluster. The default means all. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
clusterVersion:
{
Description: The cluster code version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ClusterVersions_List (removed)
Description :  Gets all available code versions for Service Fabric cluster resources by location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ClusterVersions_ListByEnvironment (removed)
Description :  Gets all available code versions for Service Fabric cluster resources by environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
environment:
{
Description: The operating system of the cluster. The default means all. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
environment:
{
Description: Indicates if this version is for Windows or Linux operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_ListUpgradableVersions (removed)
Description :  If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/listUpgradableVersions
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification. ,
Required: True ,
}
string ,
versionsDescription:
{
Description: The upgrade path description with target version. ,
Required: False ,
}
{
targetVersion:
{
Description: The target code version. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
supportedPath:
{
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Get the list of available Service Fabric resource provider API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceFabric/operations
{
api-version:
{
Description: The version of the Service Fabric resource provider API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Service Fabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the provider. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed ,
Required: False ,
}
string ,
operation:
{
Description: The operation that can be performed. ,
Required: False ,
}
string ,
description:
{
Description: Operation description ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin result ,
Required: False ,
}
string ,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}