Microsoft.ServiceFabric (stable:2016-09-01)

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

Clusters_Update (new)
Description :  Update cluster configuration
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
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: The cluster resource properties can be updated ,
Required: False ,
}
{
reliabilityLevel:
{
Description: This level is used to set the number of replicas of the system services ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The ServiceFabric code version, if set it, please make sure you have set upgradeMode to Manual, otherwise ,it will fail, if you are using PUT new cluster, you can get the version by using ClusterVersions_List, if you are updating existing cluster, you can get the availableClusterVersions from Clusters_Get ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, SSL certificate for cluster management endpoint and default admin client, the certificate should exist in the virtual machine scale sets or Azure key vault, before you add it. It will override original value ,
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 ,
}
,
clientCertificateThumbprints:
{
Description: The client thumbprint details, it is used for client access for cluster operation, it will override existing collection ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster, Note, it will overwrite existing collection ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
reverseProxyCertificate:
{
Description: Certificate for the 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 ,
}
,
nodeTypes:
{
Description: The list of node types that make up the cluster, it will override ,
Required: False ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
tags:
{
Description: Cluster update parameters ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
Clusters_Get (new)
Description :  Get cluster resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
Clusters_Create (new)
Description :  Create cluster resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
Required: True ,
}
string ,
parameters:
{
Description: Put Request ,
Required: True ,
}
{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
Clusters_Delete (new)
Description :  Delete cluster resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
Clusters_ListByResourceGroup (new)
Description :  List cluster resource by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
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 ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Clusters_List (new)
Description :  List cluster resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters
{
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
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 ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
ClusterVersions_List (new)
Description :  List cluster code versions 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 ServiceFabric resource provider api ,
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 ServiceFabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster 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 ,
}
ClusterVersions_ListByEnvironment (new)
Description :  List cluster code versions 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: Cluster operating system, the default means all ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
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 ServiceFabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster 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 ,
}
ClusterVersions_Get (new)
Description :  Get cluster code versions by environment and version
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: Cluster operating system, the default means all ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
clusterVersion:
{
Description: The cluster code version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ServiceFabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ClusterVersions_ListByVersion (new)
Description :  List cluster code versions by 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 ServiceFabric resource provider api ,
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 ServiceFabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster 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 ,
}
Operations_List (new)
Description :  Lists all of the available ServiceFabric REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of ServiceFabric operations supported by the Microsoft.ServiceFabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Result name ,
Required: False ,
}
string ,
display:
{
Description: Display of the result ,
Required: False ,
}
{
provider:
{
Description: Provider name ,
Required: False ,
}
string ,
resource:
{
Description: Resource name ,
Required: False ,
}
string ,
operation:
{
Description: Operation name ,
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 detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
Clusters_Update (removed)
Description :  Update cluster configuration
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
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: The cluster resource properties can be updated ,
Required: False ,
}
{
reliabilityLevel:
{
Description: This level is used to set the number of replicas of the system services ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The ServiceFabric code version, if set it, please make sure you have set upgradeMode to Manual, otherwise ,it will fail, if you are using PUT new cluster, you can get the version by using ClusterVersions_List, if you are updating existing cluster, you can get the availableClusterVersions from Clusters_Get ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, SSL certificate for cluster management endpoint and default admin client, the certificate should exist in the virtual machine scale sets or Azure key vault, before you add it. It will override original value ,
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 ,
}
,
clientCertificateThumbprints:
{
Description: The client thumbprint details, it is used for client access for cluster operation, it will override existing collection ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster, Note, it will overwrite existing collection ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
reverseProxyCertificate:
{
Description: Certificate for the 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 ,
}
,
nodeTypes:
{
Description: The list of node types that make up the cluster, it will override ,
Required: False ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
tags:
{
Description: Cluster update parameters ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
Clusters_Get (removed)
Description :  Get cluster resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
Clusters_Create (removed)
Description :  Create cluster resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
Required: True ,
}
string ,
parameters:
{
Description: Put Request ,
Required: True ,
}
{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster resource properties ,
Required: False ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
Clusters_Delete (removed)
Description :  Delete cluster resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
Clusters_ListByResourceGroup (removed)
Description :  List cluster resource by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters
{
resourceGroupName:
{
Description: The name of the resource group to which the resource belongs or get created ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
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 ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Clusters_List (removed)
Description :  List cluster resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters
{
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
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 ,
}
{
availableClusterVersions:
{
Description: The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to ,
Required: False ,
}
[
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterId:
{
Description: The unique identifier for the cluster resource ,
Required: False ,
}
string ,
clusterState:
{
Description: The state for the cluster ,
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 ,
clusterEndpoint:
{
Description: The endpoint for the cluster connecting to servicefabric resource provider ,
Required: False ,
}
string ,
clusterCodeVersion:
{
Description: The ServiceFabric code version running in your cluster ,
Required: False ,
}
string ,
certificate:
{
Description: This primary certificate will be used as cluster node to node security, 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 ,
}
,
reliabilityLevel:
{
Description: Cluster reliability level indicates replica set size of system service ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificateThumbprints:
{
Description: The client thumbprint details ,it is used for client access for cluster operation ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false, it is used or query only access ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: Certificate thumbprint ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateCommonNames:
{
Description: List of client certificates to trust based on common names ,
Required: False ,
}
[
{
isAdmin:
{
Description: Is this certificate used for admin access from the client, if false , it is used or query only access ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: Certificate common name to be granted access; be careful using wild card common names ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: Certificate issuer thumbprint ,
Required: True ,
}
string ,
}
,
]
,
fabricSettings:
{
Description: List of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of settings section ,
Required: True ,
}
string ,
parameters:
{
Description: Collection of settings in the section, each setting is a tuple consisting of setting name and value ,
Required: True ,
}
[
{
name:
{
Description: The name of settings property ,
Required: True ,
}
string ,
value:
{
Description: The value of the property ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
}
,
managementEndpoint:
{
Description: The http management endpoint of the cluster ,
Required: True ,
}
string ,
nodeTypes:
{
Description: The list of node types that make up the cluster ,
Required: True ,
}
[
{
name:
{
Description: 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 of a resource a node has ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: Node type durability Level ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: Ports used by applications ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: System assigned application ports ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: Mark this as the primary node type ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of node instances in the node type ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: Endpoint used by reverse proxy ,
Required: False ,
}
integer ,
}
,
]
,
azureActiveDirectory:
{
Description: The settings to enable AAD authentication on 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 ,
}
,
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 ,
vmImage:
{
Description: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. ,
Required: False ,
}
string ,
diagnosticsStorageAccountConfig:
{
Description: The storage diagnostics account configuration details ,
Required: False ,
}
{
storageAccountName:
{
Description: Diagnostics storage account name ,
Required: True ,
}
string ,
protectedAccountKeyName:
{
Description: Protected Diagnostics storage key name ,
Required: True ,
}
string ,
blobEndpoint:
{
Description: Diagnostics storage account blob endpoint ,
Required: True ,
}
string ,
queueEndpoint:
{
Description: Diagnostics storage account queue endpoint ,
Required: True ,
}
string ,
tableEndpoint:
{
Description: Diagnostics storage account table endpoint ,
Required: True ,
}
string ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
overrideUserUpgradePolicy:
{
Description: Use the user defined upgrade policy or not ,
Required: False ,
}
boolean ,
forceRestart:
{
Description: Force node to restart or not ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: Timeout for replica set upgrade to complete,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The length of time that health checks must pass continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The length of time that health checks can fail continuously,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The upgrade timeout,it represents .Net TimeSpan ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The timeout for any upgrade domain,it represents .Net TimeSpan ,
Required: True ,
}
string ,
healthPolicy:
{
Description: Cluster health Policy ,
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. ,
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. ,
Required: False ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: Delta health policy ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: Additional unhealthy nodes percentage per upgrade domain ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: Additional unhealthy applications percentage ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
ClusterVersions_List (removed)
Description :  List cluster code versions 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 ServiceFabric resource provider api ,
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 ServiceFabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster 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 ,
}
ClusterVersions_ListByEnvironment (removed)
Description :  List cluster code versions 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: Cluster operating system, the default means all ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
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 ServiceFabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster 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 ,
}
ClusterVersions_Get (removed)
Description :  Get cluster code versions by environment and version
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: Cluster operating system, the default means all ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the ServiceFabric resource provider api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
clusterVersion:
{
Description: The cluster code version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ServiceFabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster operating system ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ClusterVersions_ListByVersion (removed)
Description :  List cluster code versions by 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 ServiceFabric resource provider api ,
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 ServiceFabric runtime version result ,
Required: False ,
}
{
codeVersion:
{
Description: The ServiceFabric runtime version of the cluster ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version ,
Required: False ,
}
string ,
environment:
{
Description: Cluster 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 ,
}
Operations_List (removed)
Description :  Lists all of the available ServiceFabric REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of ServiceFabric operations supported by the Microsoft.ServiceFabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Result name ,
Required: False ,
}
string ,
display:
{
Description: Display of the result ,
Required: False ,
}
{
provider:
{
Description: Provider name ,
Required: False ,
}
string ,
resource:
{
Description: Resource name ,
Required: False ,
}
string ,
operation:
{
Description: Operation name ,
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 detail ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}