Microsoft.ServiceFabric (preview:2017-07-01)

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

Operations_List (new)
Description :  Lists all of the available ServiceFabric Resource Manager 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 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)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2017-07-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource for patch operations. ,
Required: True ,
}
{
properties:
{
Description: The application resource properties for patch operations. ,
Required: False ,
}
{
typeVersion:
{
Description: The version of the application type as defined in the application manifest. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
upgradeReplicaSetCheckTimeout:
{
Description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). ,
Required: False ,
}
string ,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The activation Mode of the service package ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: False ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
}
,
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
ConsiderWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: False ,
}
boolean ,
MaxPercentUnhealthyDeployedApplications:
{
Description: The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. ,
Required: False ,
}
integer ,
DefaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum percentage of services allowed to be unhealthy before your application is considered in error. ,
Required: False ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. ,
Required: False ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. ,
Required: False ,
}
integer ,
}
,
ServiceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
}
,
minimumNodes:
{
Description: The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNodes:
{
Description: The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. ,
Format: int64 ,
Required: False ,
}
integer ,
removeApplicationCapacity:
{
Description: Remove the current application capacity settings. ,
Required: False ,
}
boolean ,
metrics:
{
Description: List of application capacity metric description. ,
Required: False ,
}
[
{
Name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
MaximumCapacity:
{
Description: The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
ReservationCapacity:
{
Description: The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric. ,
Format: int64 ,
Required: False ,
}
integer ,
TotalApplicationCapacity:
{
Description: The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2017-07-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The service resource. ,
Required: True ,
}
{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
}

⚐ 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 cluster resource
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 API. ,
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)

{}

⚐ Response (default)

{
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. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
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. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
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. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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 ,
}
{
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). ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: The upgrade mode of the cluster. This indicates if the cluster should be automatically upgraded when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
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 30 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 ,
}
,
]
,
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. ,
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: The 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 ,
}
,
}
,
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ Response (default)

{
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
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 API. ,
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)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
ClusterVersions_Get (new)
Description :  Get cluster code versions by location
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 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 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 :  Get cluster code versions 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: Cluster operating system, the default means all ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the 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 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 :  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 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 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 :  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 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 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 :  Lists all of the available ServiceFabric Resource Manager 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 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)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Lists all of the available ServiceFabric Resource Manager 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 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)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2017-07-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource for patch operations. ,
Required: True ,
}
{
properties:
{
Description: The application resource properties for patch operations. ,
Required: False ,
}
{
typeVersion:
{
Description: The version of the application type as defined in the application manifest. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
upgradeReplicaSetCheckTimeout:
{
Description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). ,
Required: False ,
}
string ,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The activation Mode of the service package ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: False ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ,
Required: False ,
}
string ,
}
,
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
ConsiderWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: False ,
}
boolean ,
MaxPercentUnhealthyDeployedApplications:
{
Description: The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. ,
Required: False ,
}
integer ,
DefaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum percentage of services allowed to be unhealthy before your application is considered in error. ,
Required: False ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. ,
Required: False ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. ,
Required: False ,
}
integer ,
}
,
ServiceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
}
,
minimumNodes:
{
Description: The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNodes:
{
Description: The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. ,
Format: int64 ,
Required: False ,
}
integer ,
removeApplicationCapacity:
{
Description: Remove the current application capacity settings. ,
Required: False ,
}
boolean ,
metrics:
{
Description: List of application capacity metric description. ,
Required: False ,
}
[
{
Name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
MaximumCapacity:
{
Description: The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
ReservationCapacity:
{
Description: The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric. ,
Format: int64 ,
Required: False ,
}
integer ,
TotalApplicationCapacity:
{
Description: The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
typeName:
{
Description: The application type name as defined in the application manifest. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2017-07-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The service resource. ,
Required: True ,
}
{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The service resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
serviceKind:
{
Description: The kind of service (Stateless or Stateful). ,
Enum:
{
Invalid: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 1. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: False ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: False ,
}
{
PartitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Invalid: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. ,
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
}

⚐ 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 cluster resource
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 API. ,
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)

{}

⚐ Response (default)

{
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. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
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. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
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. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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 ,
}
{
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). ,
Enum:
{
Bronze: No description available. ,
Silver: No description available. ,
Gold: No description available. ,
}
,
Required: False ,
}
enum ,
upgradeMode:
{
Description: The upgrade mode of the cluster. This indicates if the cluster should be automatically upgraded when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
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 30 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 ,
}
,
]
,
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. ,
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: The 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 ,
}
,
}
,
addOnFeatures:
{
Description: The list of add-on features to enable in the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ Response (default)

{
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
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)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
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 API. ,
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)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
ClusterVersions_Get (removed)
Description :  Get cluster code versions by location
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 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 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 :  Get cluster code versions 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: Cluster operating system, the default means all ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the 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 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 :  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 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 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 :  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 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 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 :  Lists all of the available ServiceFabric Resource Manager 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 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)

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