Azure Service Fabric Services API

openapi: 3.2.0
info:
  title: ServiceFabricManagedClustersManagementClient Services API
  version: '2026-02-01'
  description: Service Fabric Managed Clusters Management Client
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Services
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}/services
  : get:
      operationId: Services_ListByApplications
      tags:
      - Services
      description: Gets all service resources created or in the process of being created in the Service Fabric managed application resource.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterName
        in: path
        description: The name of the cluster resource.
        required: true
        schema:
          type: string
      - name: applicationName
        in: path
        description: The name of the application resource.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResourceList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get a list of service resources:
          $ref: ./examples/ServiceListOperation_example.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Services list by applications
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}/services/{serviceName}
  : get:
      operationId: Services_Get
      tags:
      - Services
      description: Get a Service Fabric service resource created or in the process of being created in the Service Fabric managed application resource.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterName
        in: path
        description: The name of the cluster resource.
        required: true
        schema:
          type: string
      - name: applicationName
        in: path
        description: The name of the application resource.
        required: true
        schema:
          type: string
      - name: serviceName
        in: path
        description: The name of the service resource in the format of {applicationName}~{serviceName}.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get a service:
          $ref: ./examples/ServiceGetOperation_example.json
      summary: Services get
      x-summary-source: derived
    put:
      operationId: Services_CreateOrUpdate
      tags:
      - Services
      description: Create or update a Service Fabric managed service resource with the specified name.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterName
        in: path
        description: The name of the cluster resource.
        required: true
        schema:
          type: string
      - name: applicationName
        in: path
        description: The name of the application resource.
        required: true
        schema:
          type: string
      - name: serviceName
        in: path
        description: The name of the service resource in the format of {applicationName}~{serviceName}.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'ServiceResource' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResource'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
                format: uri
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Put a service with maximum parameters:
          $ref: ./examples/ServicePutOperation_example_max.json
        Put a service with minimum parameters:
          $ref: ./examples/ServicePutOperation_example_min.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/ServiceResource'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceResource'
        description: The service resource.
        required: true
      summary: Services create or update
      x-summary-source: derived
    patch:
      operationId: Services_Update
      tags:
      - Services
      description: Updates the tags of a service resource of a given managed cluster.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterName
        in: path
        description: The name of the cluster resource.
        required: true
        schema:
          type: string
      - name: applicationName
        in: path
        description: The name of the application resource.
        required: true
        schema:
          type: string
      - name: serviceName
        in: path
        description: The name of the service resource in the format of {applicationName}~{serviceName}.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Patch a service:
          $ref: ./examples/ServicePatchOperation_example.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceUpdateParameters'
        description: The service resource updated tags.
        required: true
      summary: Services update
      x-summary-source: derived
    delete:
      operationId: Services_Delete
      tags:
      - Services
      description: Delete a Service Fabric managed service resource with the specified name.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterName
        in: path
        description: The name of the cluster resource.
        required: true
        schema:
          type: string
      - name: applicationName
        in: path
        description: The name of the application resource.
        required: true
        schema:
          type: string
      - name: serviceName
        in: path
        description: The name of the service resource in the format of {applicationName}~{serviceName}.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
                format: uri
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete a service:
          $ref: ./examples/ServiceDeleteOperation_example.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Services delete
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}/services/{serviceName}/restartReplica
  : post:
      operationId: Services_RestartReplica
      tags:
      - Services
      description: A long-running resource action.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterName
        in: path
        description: The name of the cluster resource.
        required: true
        schema:
          type: string
      - name: applicationName
        in: path
        description: The name of the application resource.
        required: true
        schema:
          type: string
      - name: serviceName
        in: path
        description: The name of the service resource in the format of {applicationName}~{serviceName}.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Resource operation accepted.
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
                format: uri
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Restart replicas:
          $ref: ./examples/ServiceActionRestartReplica_example.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestartReplicaRequest'
        description: The parameters for restarting replicas.
        required: true
      summary: Services restart replica
      x-summary-source: derived
components:
  schemas:
    ServiceKind:
      type: string
      description: The kind of service (Stateless or Stateful).
      enum:
      - Stateless
      - Stateful
      x-ms-enum:
        name: ServiceKind
        modelAsString: true
        values:
        - name: Stateless
          value: Stateless
          description: Does not use Service Fabric to make its state highly available or reliable. The value is 0.
        - name: Stateful
          value: Stateful
          description: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1.
    ServiceLoadMetric:
      type: object
      description: Specifies a metric to load balance a service during runtime.
      properties:
        name:
          type: string
          description: The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.
        weight:
          $ref: '#/components/schemas/ServiceLoadMetricWeight'
          description: The service load metric relative weight, compared to other metrics configured for this service, as a number.
        primaryDefaultLoad:
          type: integer
          format: int32
          description: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
        secondaryDefaultLoad:
          type: integer
          format: int32
          description: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
        defaultLoad:
          type: integer
          format: int32
          description: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
      required:
      - name
    ServiceResourcePropertiesBase:
      type: object
      description: The common service resource properties.
      properties:
        placementConstraints:
          type: string
          description: 'The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".'
        correlationScheme:
          type: array
          description: A list that describes the correlation of the service with other services.
          items:
            $ref: '#/components/schemas/ServiceCorrelation'
          x-ms-identifiers: []
        serviceLoadMetrics:
          type: array
          description: The service load metrics is given as an array of ServiceLoadMetric objects.
          items:
            $ref: '#/components/schemas/ServiceLoadMetric'
          x-ms-identifiers: []
        servicePlacementPolicies:
          type: array
          description: A list that describes the correlation of the service with other services.
          items:
            $ref: '#/components/schemas/ServicePlacementPolicy'
          x-ms-identifiers: []
        defaultMoveCost:
          $ref: '#/components/schemas/MoveCost'
          description: Specifies the move cost for the service.
        scalingPolicies:
          type: array
          description: Scaling policies for this service.
          items:
            $ref: '#/components/schemas/ScalingPolicy'
          x-ms-identifiers: []
    ServiceCorrelation:
      type: object
      description: Creates a particular correlation between services.
      properties:
        scheme:
          $ref: '#/components/schemas/ServiceCorrelationScheme'
          description: The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName.
        serviceName:
          type: string
          description: The Arm Resource ID of the service that the correlation relationship is established with.
      required:
      - scheme
      - serviceName
    RestartKind:
      type: string
      description: The kind of restart to perform.
      enum:
      - Simultaneous
      x-ms-enum:
        name: RestartKind
        modelAsString: true
        values:
        - name: Simultaneous
          value: Simultaneous
          description: Restart all listed replicas at the same time.
    RestartReplicaRequest:
      type: object
      description: Request to restart a replica.
      properties:
        partitionId:
          type: string
          description: The ID of the partition.
        replicaIds:
          type: array
          description: The IDs of the replicas to be restarted.
          items:
            type: integer
            format: int64
        restartKind:
          $ref: '#/components/schemas/RestartKind'
          description: The kind of restart to perform.
        forceRestart:
          type: boolean
          description: If true, the restart operation will be forced. Use this option with care, as it may cause data loss.
        timeout:
          type: integer
          format: int64
          description: The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
      required:
      - partitionId
      - replicaIds
      - restartKind
    ServiceScalingTriggerKind:
      type: string
      description: Enumerates the ways that a service can be partitioned.
      enum:
      - AveragePartitionLoadTrigger
      - AverageServiceLoadTrigger
      x-ms-enum:
        name: ServiceScalingTriggerKind
        modelAsString: true
        values:
        - name: AveragePartitionLoadTrigger
          value: AveragePartitionLoadTrigger
          description: Represents a scaling trigger related to an average load of a metric/resource of a partition. The value is 0.
        - name: AverageServiceLoadTrigger
          value: AverageServiceLoadTrigger
          description: Represents a scaling policy related to an average load of a metric/resource of a service. The value is 1.
    ServiceLoadMetricWeight:
      type: string
      description: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.
      enum:
      - Zero
      - Low
      - Medium
      - High
      x-ms-enum:
        name: ServiceLoadMetricWeight
        modelAsString: true
        values:
        - name: Zero
          value: Zero
          description: Disables resource balancing for this metric. This value is zero.
        - name: Low
          value: Low
          description: Specifies the metric weight of the service load as Low. The value is 1.
        - name: Medium
          value: Medium
          description: Specifies the metric weight of the service load as Medium. The value is 2.
        - name: High
          value: High
          description: Specifies the metric weight of the service load as High. The value is 3.
    ServicePlacementPolicy:
      type: object
      description: Describes the policy to be used for placement of a Service Fabric service.
      properties:
        type:
          $ref: '#/components/schemas/ServicePlacementPolicyType'
      discriminator:
        propertyName: type
      required:
      - type
    ScalingMechanism:
      type: object
      description: Describes the mechanism for performing a scaling operation.
      properties:
        kind:
          $ref: '#/components/schemas/ServiceScalingMechanismKind'
      discriminator:
        propertyName: kind
      required:
      - kind
    MoveCost:
      type: string
      description: Specifies the move cost for the service.
      enum:
      - Zero
      - Low
      - Medium
      - High
      x-ms-enum:
        name: MoveCost
        modelAsString: true
        values:
        - name: Zero
          value: Zero
          description: Zero move cost. This value is zero.
        - name: Low
          value: Low
          description: Specifies the move cost of the service as Low. The value is 1.
        - name: Medium
          value: Medium
          description: Specifies the move cost of the service as Medium. The value is 2.
        - name: High
          value: High
          description: Specifies the move cost of the service as High. The value is 3.
    ScalingTrigger:
      type: object
      description: Describes the trigger for performing a scaling operation.
      properties:
        kind:
          $ref: '#/components/schemas/ServiceScalingTriggerKind'
      discriminator:
        propertyName: kind
      required:
      - kind
    Partition:
      type: object
      description: Describes how the service is partitioned.
      properties:
        partitionScheme:
          $ref: '#/components/schemas/PartitionScheme'
      discriminator:
        propertyName: partitionScheme
      required:
      - partitionScheme
    ServicePackageActivationMode:
      type: string
      description: The activation Mode of the service package
      enum:
      - SharedProcess
      - ExclusiveProcess
      x-ms-enum:
        name: ServicePackageActivationMode
        modelAsString: true
        values:
        - name: SharedProcess
          value: SharedProcess
          description: Indicates the application package activation mode will use shared process.
        - name: ExclusiveProcess
          value: ExclusiveProcess
          description: Indicates the application package activation mode will use exclusive process.
    PartitionScheme:
      type: string
      description: Enumerates the ways that a service can be partitioned.
      enum:
      - Singleton
      - UniformInt64Range
      - Named
      x-ms-enum:
        name: PartitionScheme
        modelAsString: true
        values:
        - name: Singleton
          value: Singleton
          description: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0.
        - name: UniformInt64Range
          value: UniformInt64Range
          description: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1.
        - name: Named
          value: Named
          description: Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2.
    ScalingPolicy:
      type: object
      description: Specifies a metric to load balance a service during runtime.
      properties:
        scalingMechanism:
          $ref: '#/components/schemas/ScalingMechanism'
          description: Specifies the mechanism associated with this scaling policy
        scalingTrigger:
          $ref: '#/components/schemas/ScalingTrigger'
          description: Specifies the trigger associated with this scaling policy.
      required:
      - scalingMechanism
      - scalingTrigger
    ServiceResourceList:
      type: object
      description: The list of service resources.
      properties:
        value:
          type: array
          description: The ServiceResource items on this page
          items:
            $ref: '#/components/schemas/ServiceResource'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ServiceResource:
      type: object
      description: The service resource.
      properties:
        properties:
          $ref: '#/components/schemas/ServiceResourceProperties'
          description: The service resource properties.
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
    ServiceCorrelationScheme:
      type: string
      description: The service correlation scheme.
      enum:
      - AlignedAffinity
      - NonAlignedAffinity
      x-ms-enum:
        name: ServiceCorrelationScheme
        modelAsString: true
        values:
        - name: AlignedAffinity
          value: AlignedAffinity
          description: Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 0.
        - name: NonAlignedAffinity
          value: NonAlignedAffinity
          description: Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 1.
    ServiceResourceProperties:
      type: object
      description: The service resource properties.
      properties:
        provisioningState:
          type: string
          description: The current deployment or provisioning state, which only appears in the response
          readOnly: true
        serviceKind:
          $ref: '#/components/schemas/ServiceKind'
          description: The kind of service (Stateless or Stateful).
        serviceTypeName:
          type: string
          description: The name of the service type
        partitionDescription:
          $ref: '#/components/schemas/Partition'
          description: Describes how the service is partitioned.
        servicePackageActivationMode:
          $ref: '#/components/schemas/ServicePackageActivationMode'
          description: The activation Mode of the service package
        serviceDnsName:
          type: string
          description: 'Dns name used for the service. If this is specified, then the DNS name can be used to return the IP addresses of service endpoints for application layer protocols (e.g., HTTP).

            When updating serviceDnsName, old name may be temporarily resolvable. However, rely on new name.

            When removing serviceDnsName, removed name may temporarily be resolvable. Do not rely on the name being unresolvable.'
      discriminator:
        propertyName: serviceKind
      required:
      - serviceKind
      - serviceTypeName
      - partitionDescription
      allOf:
      - $ref: '#/components/schemas/ServiceResourcePropertiesBase'
    ServicePlacementPolicyType:
      type: string
      description: The type of placement policy for a service fabric service. Following are the possible values.
      enum:
      - InvalidDomain
      - RequiredDomain
      - PreferredPrimaryDomain
      - RequiredDomainDistribution
      - NonPartiallyPlaceService
      x-ms-enum:
        name: ServicePlacementPolicyType
        modelAsString: true
        values:
        - name: InvalidDomain
          value: InvalidDomain
          description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 0.
        - name: RequiredDomain
          value: RequiredDomain
          description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 1.
        - name: PreferredPrimaryDomain
          value: PreferredPrimaryDomain
          description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 2.
        - name: RequiredDomainDistribution
          value: RequiredDomainDistribution
          description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 3.
        - name: NonPartiallyPlaceService
          value: NonPartiallyPlaceService
          description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 4.
    ServiceUpdateParameters:
      type: object
      description: Service update request
      properties:
        tags:
          type: object
          description: Service update parameters
          additionalProperties:
            type: string
    ServiceScalingMechanismKind:
      type: string
      description: Enumerates the ways that a service can be partitioned.
      enum:
      - ScalePartitionInstanceCount
      - AddRemoveIncrementalNamedPartition
      x-ms-enum:
        name: ServiceScalingMechanismKind
        modelAsString: true
        values:
        - name: ScalePartitionInstanceCount
          value: ScalePartitionInstanceCount
          description: Represents a scaling mechanism for adding or removing instances of stateless service partition. The value is 0.
        - name: AddRemoveIncrementalNamedPartition
          value: AddRemoveIncrementalNamedPartition
          description: Represents a scaling mechanism for adding or removing named partitions of a stateless service. The value is 1.
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.