Microsoft.ServiceFabric (preview:2021-09-01-privatepreview)

2025/09/12 • 42 new, 42 deleted methods

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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_Update (new)
Description :  Updates the tags of an application type resource of a given managed cluster.
Reference :  Link ¶

⚼ Request

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

⚐ 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 managed application type name resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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 managed cluster resource.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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 ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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_Update (new)
Description :  Updates the tags of an application type version resource of a given managed cluster.
Reference :  Link ¶

⚼ Request

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

⚐ 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 ,
}
,
}

⚐ 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 managed application type version resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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_ListByApplicationTypes (new)
Description :  Gets all application type version resources created or in the process of being created in the Service Fabric managed application type name resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of application type version list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_Get (new)
Description :  Get a Service Fabric managed 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/managedclusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

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

⚐ Response (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 :  Updates the tags of an application resource of a given managed cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource updated tags. ,
Required: True ,
}
{
tags:
{
Description: Application update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

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

⚐ Response (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 managed application resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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 managed 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/managedclusters/{clusterName}/applications
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 :  Updates the tags of a service resource of a given managed cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The service resource updated tags. ,
Required: True ,
}
{
tags:
{
Description: Service update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 managed service resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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_ListByApplications (new)
Description :  Gets all service resources created or in the process of being created in the Service Fabric managed application resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of service list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
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 ,
}
,
}
ManagedClusters_CreateOrUpdate (new)
Description :  Create or update a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster resource. ,
Required: True ,
}
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
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 ,
}
,
}
ManagedClusters_Update (new)
Description :  Update the tags of of a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The managed cluster resource updated tags. ,
Required: True ,
}
{
tags:
{
Description: Managed cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
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 ,
}
,
}
ManagedClusters_Delete (new)
Description :  Delete a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
ManagedClusterVersion_Get (new)
Description :  Gets information about an available Service Fabric managed cluster code version.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
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 ,
}
{
clusterCodeVersion:
{
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 ,
osType:
{
Description: Cluster operating system, the default will be Windows ,
Enum:
{
Windows: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
ManagedClusterVersion_GetByEnvironment (new)
Description :  Gets information about an available Service Fabric cluster code version by environment.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
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 ,
}
{
clusterCodeVersion:
{
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 ,
osType:
{
Description: Cluster operating system, the default will be Windows ,
Enum:
{
Windows: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
ManagedClusterVersion_List (new)
Description :  Gets all available code versions for Service Fabric cluster resources by location.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
clusterCodeVersion:
{
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 ,
osType:
{
Description: Cluster operating system, the default will be Windows ,
Enum:
{
Windows: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
ManagedClusterVersion_ListByEnvironment (new)
Description :  Gets all available code versions for Service Fabric cluster resources by environment.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
clusterCodeVersion:
{
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 ,
osType:
{
Description: Cluster operating system, the default will be Windows ,
Enum:
{
Windows: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
managedUnsupportedVMSizes_List (new)
Description :  Get the lists of unsupported vm sizes for Service Fabric Managed Clusters.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Managed VM Sizes for Service Fabric Managed Clusters. ,
Required: False ,
}
[
{
properties:
{
Description: VM Size properties. ,
Required: False ,
}
{
size:
{
Description: VM Size name. ,
Required: False ,
}
string ,
}
,
id:
{
Description: VM Size id. ,
Required: False ,
}
string ,
name:
{
Description: VM Size name. ,
Required: False ,
}
string ,
type:
{
Description: VM Size type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Managed VM Sizes if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
managedUnsupportedVMSizes_Get (new)
Description :  Get unsupported vm size for Service Fabric Managed Clusters.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: VM Size properties. ,
Required: False ,
}
{
size:
{
Description: VM Size name. ,
Required: False ,
}
string ,
}
,
id:
{
Description: VM Size id. ,
Required: False ,
}
string ,
name:
{
Description: VM Size name. ,
Required: False ,
}
string ,
type:
{
Description: VM Size type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_ListByManagedClusters (new)
Description :  Gets all Node types of the specified managed cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of node types. ,
Required: False ,
}
[
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Restart (new)
Description :  Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/restart
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for restart action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
NodeTypes_Reimage (new)
Description :  Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/reimage
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for reimage action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
NodeTypes_DeleteNode (new)
Description :  Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/deleteNode
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for delete action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
NodeTypeSkus_List (new)
Description :  Get a Service Fabric node type supported SKUs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/skus
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available node type SKUs. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the sku applies to.

Value: Microsoft.ServiceFabric/managedClusters/nodeTypes. ,
Required: False ,
}
string ,
sku:
{
Description: The supported SKU for a for node type. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
}
,
capacity:
{
Description: Provides information about how the node count can be scaled. ,
Required: False ,
}
{
minimum:
{
Description: Lowest permitted node count in a node type. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Highest permitted node count in a node type. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default node count in a node type. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Node type capacity scale type. ,
Enum:
{
None: Node count is not adjustable in any way (e.g. it is fixed). ,
Manual: The user must manually scale out/in. ,
Automatic: Automatic scale is allowed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Get (new)
Description :  Get a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
}
NodeTypes_CreateOrUpdate (new)
Description :  Create or update a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The node type resource. ,
Required: True ,
}
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
}
NodeTypes_Update (new)
Description :  Update the configuration of a node type of a given managed cluster, only updating tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update the node type configuration. ,
Required: True ,
}
{
tags:
{
Description: Node type update parameters ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
additionalProperties:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
}
NodeTypes_Delete (new)
Description :  Delete a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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_Update (removed)
Description :  Updates the tags of an application type resource of a given managed cluster.
Reference :  Link ¶

⚼ Request

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

⚐ 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 managed application type name resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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 managed cluster resource.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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 ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
version:
{
Description: The application type version. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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_Update (removed)
Description :  Updates the tags of an application type version resource of a given managed cluster.
Reference :  Link ¶

⚼ Request

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

⚐ 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 ,
}
,
}

⚐ 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 managed application type version resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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_ListByApplicationTypes (removed)
Description :  Gets all application type version resources created or in the process of being created in the Service Fabric managed application type name resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationTypeName:
{
Description: The name of the application type name resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of application type version list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Applications_Get (removed)
Description :  Get a Service Fabric managed 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/managedclusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

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

⚐ Response (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 :  Updates the tags of an application resource of a given managed cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource updated tags. ,
Required: True ,
}
{
tags:
{
Description: Application update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

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

⚐ Response (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 managed application resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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 managed 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/managedclusters/{clusterName}/applications
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 :  Updates the tags of a service resource of a given managed cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service resource in the format of {applicationName}~{serviceName}. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The service resource updated tags. ,
Required: True ,
}
{
tags:
{
Description: Service update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 managed service resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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_ListByApplications (removed)
Description :  Gets all service resources created or in the process of being created in the Service Fabric managed application resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" 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:
{
Stateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. ,
Stateful: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1. ,
}
,
Required: True ,
}
enum ,
serviceTypeName:
{
Description: The name of the service type ,
Required: True ,
}
string ,
partitionDescription:
{
Description: Describes how the service is partitioned. ,
Required: True ,
}
{
partitionScheme:
{
Description: Specifies how the service is partitioned. ,
Enum:
{
Singleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. ,
UniformInt64Range: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1. ,
Named: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2. ,
}
,
Required: True ,
}
enum ,
}
,
servicePackageActivationMode:
{
Description: The activation Mode of the service package ,
Enum:
{
SharedProcess: Indicates the application package activation mode will use shared process. ,
ExclusiveProcess: Indicates the application package activation mode will use exclusive process. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of service list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
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 ,
}
,
}
ManagedClusters_CreateOrUpdate (removed)
Description :  Create or update a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster resource. ,
Required: True ,
}
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
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 ,
}
,
}
ManagedClusters_Update (removed)
Description :  Update the tags of of a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The managed cluster resource updated tags. ,
Required: True ,
}
{
tags:
{
Description: Managed cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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 ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. ,
Required: True ,
}
string ,
tag:
{
Description: The value of the IP tag. ,
Required: True ,
}
string ,
}
,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
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 ,
}
,
}
ManagedClusters_Delete (removed)
Description :  Delete a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
ManagedClusterVersion_Get (removed)
Description :  Gets information about an available Service Fabric managed cluster code version.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
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 ,
}
{
clusterCodeVersion:
{
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 ,
osType:
{
Description: Cluster operating system, the default will be Windows ,
Enum:
{
Windows: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
ManagedClusterVersion_GetByEnvironment (removed)
Description :  Gets information about an available Service Fabric cluster code version by environment.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
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 ,
}
{
clusterCodeVersion:
{
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 ,
osType:
{
Description: Cluster operating system, the default will be Windows ,
Enum:
{
Windows: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
ManagedClusterVersion_List (removed)
Description :  Gets all available code versions for Service Fabric cluster resources by location.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
clusterCodeVersion:
{
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 ,
osType:
{
Description: Cluster operating system, the default will be Windows ,
Enum:
{
Windows: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
ManagedClusterVersion_ListByEnvironment (removed)
Description :  Gets all available code versions for Service Fabric cluster resources by environment.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: The identification of the result ,
Required: False ,
}
string ,
name:
{
Description: The name of the result ,
Required: False ,
}
string ,
type:
{
Description: The result resource type ,
Required: False ,
}
string ,
properties:
{
Description: The detail of the Service Fabric runtime version result ,
Required: False ,
}
{
clusterCodeVersion:
{
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 ,
osType:
{
Description: Cluster operating system, the default will be Windows ,
Enum:
{
Windows: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
managedUnsupportedVMSizes_List (removed)
Description :  Get the lists of unsupported vm sizes for Service Fabric Managed Clusters.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Managed VM Sizes for Service Fabric Managed Clusters. ,
Required: False ,
}
[
{
properties:
{
Description: VM Size properties. ,
Required: False ,
}
{
size:
{
Description: VM Size name. ,
Required: False ,
}
string ,
}
,
id:
{
Description: VM Size id. ,
Required: False ,
}
string ,
name:
{
Description: VM Size name. ,
Required: False ,
}
string ,
type:
{
Description: VM Size type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Managed VM Sizes if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
managedUnsupportedVMSizes_Get (removed)
Description :  Get unsupported vm size for Service Fabric Managed Clusters.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: VM Size properties. ,
Required: False ,
}
{
size:
{
Description: VM Size name. ,
Required: False ,
}
string ,
}
,
id:
{
Description: VM Size id. ,
Required: False ,
}
string ,
name:
{
Description: VM Size name. ,
Required: False ,
}
string ,
type:
{
Description: VM Size type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_ListByManagedClusters (removed)
Description :  Gets all Node types of the specified managed cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of node types. ,
Required: False ,
}
[
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Restart (removed)
Description :  Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/restart
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for restart action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
NodeTypes_Reimage (removed)
Description :  Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/reimage
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for reimage action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
NodeTypes_DeleteNode (removed)
Description :  Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/deleteNode
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for delete action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
NodeTypeSkus_List (removed)
Description :  Get a Service Fabric node type supported SKUs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/skus
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available node type SKUs. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the sku applies to.

Value: Microsoft.ServiceFabric/managedClusters/nodeTypes. ,
Required: False ,
}
string ,
sku:
{
Description: The supported SKU for a for node type. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
}
,
capacity:
{
Description: Provides information about how the node count can be scaled. ,
Required: False ,
}
{
minimum:
{
Description: Lowest permitted node count in a node type. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Highest permitted node count in a node type. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default node count in a node type. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Node type capacity scale type. ,
Enum:
{
None: Node count is not adjustable in any way (e.g. it is fixed). ,
Manual: The user must manually scale out/in. ,
Automatic: Automatic scale is allowed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Get (removed)
Description :  Get a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
}
NodeTypes_CreateOrUpdate (removed)
Description :  Create or update a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The node type resource. ,
Required: True ,
}
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
}
NodeTypes_Update (removed)
Description :  Update the configuration of a node type of a given managed cluster, only updating tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update the node type configuration. ,
Required: True ,
}
{
tags:
{
Description: Node type update parameters ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
additionalProperties:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
}
,
Required: False ,
}
enum ,
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 ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: No description available. ,
https: No description available. ,
tcp: No description available. ,
udp: No description available. ,
icmp: No description available. ,
ah: No description available. ,
esp: No description available. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: No description available. ,
deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type.

Possible Values:
**Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
}
NodeTypes_Delete (removed)
Description :  Delete a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
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 ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-09-01-privatepreview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}