Microsoft.ServiceFabric (stable:2018-02-01)

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

Clusters_Get (new)
Description :  Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2018-02-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters which contains the property value and property name which used to update the cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: Describes the cluster resource properties that can be updated during PATCH operation. ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
nodeTypes:
{
Description: The list of node types in the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM SKUs like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Required: False ,
}
integer ,
}
,
]
,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available. - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2018-02-01" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters which contains the property value and property name which used to update the cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: Describes the cluster resource properties that can be updated during PATCH operation. ,
Required: False ,
}
{
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
certificate:
{
Description: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
certificateCommonNames:
{
Description: Describes a list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
{
commonNames:
{
Description: The list of server certificates referenced by common name that are used to secure the cluster. ,
Required: False ,
}
[
{
certificateCommonName:
{
Description: The common name of the server certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the server certificate. ,
Required: True ,
}
string ,
}
,
]
,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateCommonNames:
{
Description: The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateCommonName:
{
Description: The common name of the client certificate. ,
Required: True ,
}
string ,
certificateIssuerThumbprint:
{
Description: The issuer thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clientCertificateThumbprints:
{
Description: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
certificateThumbprint:
{
Description: The thumbprint of the client certificate. ,
Required: True ,
}
string ,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
nodeTypes:
{
Description: The list of node types in the cluster. This will overwrite the existing list. ,
Required: False ,
}
[
{
name:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
clientConnectionEndpointPort:
{
Description: The TCP cluster management endpoint port. ,
Required: True ,
}
integer ,
httpGatewayEndpointPort:
{
Description: The HTTP cluster management endpoint port. ,
Required: True ,
}
integer ,
durabilityLevel:
{
Description: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM SKUs like D15_V2, G5 etc. ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Required: True ,
}
integer ,
}
,
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. ,
Required: True ,
}
integer ,
reverseProxyEndpointPort:
{
Description: The endpoint used by reverse proxy. ,
Required: False ,
}
integer ,
}
,
]
,
reliabilityLevel:
{
Description: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9. ,
Enum:
{
None: No description available. ,
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
Platinum: No description available. ,
}
,
Required: False ,
}
enum ,
reverseProxyCertificate:
{
Description: The server certificate used by reverse proxy. ,
Required: False ,
}
{
thumbprint:
{
Description: Thumbprint of the primary certificate. ,
Required: True ,
}
string ,
thumbprintSecondary:
{
Description: Thumbprint of the secondary certificate. ,
Required: False ,
}
string ,
x509StoreName:
{
Description: The local certificate store location. ,
Enum:
{
AddressBook: No description available. ,
AuthRoot: No description available. ,
CertificateAuthority: No description available. ,
Disallowed: No description available. ,
My: No description available. ,
Root: No description available. ,
TrustedPeople: No description available. ,
TrustedPublisher: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
upgradeReplicaSetCheckTimeout:
{
Description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Required: True ,
}
string ,
healthPolicy:
{
Description: The cluster health policy used when upgrading the cluster. ,
Required: True ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Required: False ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Required: False ,
}
integer ,
applicationHealthPolicies:
{
Description: Defines the application health policy map used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
object ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy used when upgrading the cluster. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Required: True ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. ,
Required: True ,
}
integer ,
applicationDeltaHealthPolicies:
{
Description: Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster. ,
Required: False ,
}
object ,
}
,
}
,
upgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available. - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: The cluster resource ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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