Microsoft Azure
Microsoft Azure ServiceType API

The ServiceType API from Microsoft Azure — 5 operation(s) for servicetype.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ServiceType API
schemes:
- https
tags:
- name: ServiceType
paths:
  /ApplicationTypes/{applicationTypeName}/$/GetServiceTypes:
    get:
      summary: Microsoft Azure Gets The List Containing The Information About Service Types That Are Supported By A Provisioned Application Type In A Service Fabric Cluster
      description: Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.
      operationId: microsoftAzureGetservicetypeinfolist
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationTypeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationTypeVersionRequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - ServiceType
      x-ms-examples:
        Get information about all nodes.:
          $ref: ./examples/GetServiceTypeInfoList-1.json
      responses:
        '200':
          description: List of service types that are supported by a provisioned application type.
          schema:
            $ref: '#/definitions/ServiceTypeInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}:
    get:
      summary: Microsoft Azure Gets The Information About A Specific Service Type That Is Supported By A Provisioned Application Type In A Service Fabric Cluster
      description: Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specified service type is not found in the cluster.
      operationId: microsoftAzureGetservicetypeinfobyname
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationTypeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationTypeVersionRequiredQueryParam'
      - $ref: '#/parameters/ServiceTypeNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - ServiceType
      x-ms-examples:
        Get information about all nodes.:
          $ref: ./examples/GetServiceTypeInfoByName-1.json
      responses:
        '200':
          description: A specific service type which supported by a provisioned application type.
          schema:
            $ref: '#/definitions/ServiceTypeInfo'
        '204':
          description: A 204 response is returned if the specified service type is not found in the cluster.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /ApplicationTypes/{applicationTypeName}/$/GetServiceManifest:
    get:
      summary: Microsoft Azure Gets The Manifest Describing A Service Type
      description: Gets the manifest describing a service type. The response contains the service manifest XML as a string.
      operationId: microsoftAzureGetservicemanifest
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationTypeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationTypeVersionRequiredQueryParam'
      - $ref: '#/parameters/ServiceManifestNameRequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - ServiceType
      responses:
        '200':
          description: Information about the service type.
          schema:
            $ref: '#/definitions/ServiceTypeManifest'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes:
    get:
      summary: Microsoft Azure Gets The List Containing The Information About Service Types From The Applications Deployed On A Node In A Service Fabric Cluster
      description: Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.
      operationId: microsoftAzureGetdeployedservicetypeinfolist
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - ServiceType
      responses:
        '200':
          description: List of information about service types of an application deployed on a node.
          schema:
            $ref: '#/definitions/DeployedServiceTypeInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}:
    get:
      summary: Microsoft Azure Gets The Information About A Specified Service Type Of The Application Deployed On A Node In A Service Fabric Cluster
      description: Gets the list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package. Each entry represents one activation of a service type, differentiated by the activation ID.
      operationId: microsoftAzureGetdeployedservicetypeinfobyname
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ServiceTypeNameRequiredPathParam'
      - $ref: '#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - ServiceType
      responses:
        '200':
          description: Information about service types of an application deployed on a node.
          schema:
            $ref: '#/definitions/DeployedServiceTypeInfoList'
        '204':
          description: An empty response is returned if the specified service type of the application is not deployed on the node.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
definitions:
  ServicePlacementPolicyType:
    type: string
    description: The type of placement policy for a service fabric service. Following are the possible values.
    enum:
    - Invalid
    - InvalidDomain
    - RequireDomain
    - PreferPrimaryDomain
    - RequireDomainDistribution
    - NonPartiallyPlaceService
    - AllowMultipleStatelessInstancesOnNode
    x-ms-enum:
      name: ServicePlacementPolicyType
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - 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 1.
      - value: RequireDomain
        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 2.
      - value: PreferPrimaryDomain
        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 3.
      - value: RequireDomainDistribution
        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 4.
      - 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 5.
      - value: AllowMultipleStatelessInstancesOnNode
        description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementAllowMultipleStatelessInstancesOnNodePolicyDescription, which indicates that multiple stateless instances of a particular partition of the service can be placed on a node. The value is 6.
  DeployedServiceTypeInfo:
    description: Information about service type deployed on a node, information such as the status of the service type registration on a node.
    properties:
      ServiceTypeName:
        $ref: '#/definitions/ServiceTypeName'
        description: Name of the service type as specified in the service manifest.
      ServiceManifestName:
        $ref: '#/definitions/ServiceManifestName'
        description: The name of the service manifest in which this service type is defined.
      CodePackageName:
        $ref: '#/definitions/CodePackageName'
        description: The name of the code package that registered the service type.
      Status:
        $ref: '#/definitions/ServiceTypeRegistrationStatus'
        description: The status of the service type registration on the node.
      ServicePackageActivationId:
        $ref: '#/definitions/ServicePackageActivationId'
        description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service

          is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId

          is always an empty string.'
  FabricErrorError:
    description: Error object containing error code and error message.
    properties:
      Code:
        $ref: '#/definitions/FabricErrorCodes'
        description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n  - Possible values of the error code for HTTP status code 400 (Bad Request)\n    - \"FABRIC_E_INVALID_PARTITION_KEY\"\n    - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_ADDRESS\"\n    - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n    - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_CONFIGURATION\"\n    - \"FABRIC_E_INVALID_NAME_URI\"\n    - \"FABRIC_E_PATH_TOO_LONG\"\n    - \"FABRIC_E_KEY_TOO_LARGE\"\n    - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n    - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n    - \"FABRIC_E_VALUE_EMPTY\"\n    - \"FABRIC_E_BACKUP_IS_ENABLED\"\n    - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n    - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n    - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n    - \"E_INVALIDARG\"\n\n  - Possible values of the error code for HTTP status code 404 (Not Found)\n    - \"FABRIC_E_NODE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n    - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n    - \"FABRIC_E_PARTITION_NOT_FOUND\"\n    - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n    - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n    - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n    - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n    - \"FABRIC_E_FILE_NOT_FOUND\"\n    - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n    - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n    - \"FABRIC_E_ENUMERATION_COMPLETED\"\n    - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n    - \"FABRIC_E_KEY_NOT_FOUND\"\n    - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n    - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n    - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n    - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n    - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n  - Possible values of the error code for HTTP status code 409 (Conflict)\n    - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n    - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n    - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n    - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n    - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n    - \"FABRIC_E_NAME_NOT_EMPTY\"\n    - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n    - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n    - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n    - \"FABRIC_E_HEALTH_STALE_REPORT\"\n    - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n    - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n    - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n    - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n    - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n    - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n  - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n    - \"FABRIC_E_NODE_IS_UP\"\n    - \"E_FAIL\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n    - \"FABRIC_E_VOLUME_NOT_FOUND\"\n    - \"SerializationError\"\n\n  - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n    - \"FABRIC_E_NO_WRITE_QUORUM\"\n    - \"FABRIC_E_NOT_PRIMARY\"\n    - \"FABRIC_E_NOT_READY\"\n    - \"FABRIC_E_RECONFIGURATION_PENDING\"\n    - \"FABRIC_E_SERVICE_OFFLINE\"\n    - \"E_ABORT\"\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n    - \"FABRIC_E_COMMUNICATION_ERROR\"\n    - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n    - \"FABRIC_E_TIMEOUT\""
      Message:
        type: string
        description: Error message.
    required:
    - Code
  ServicePackageActivationId:
    type: string
    description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service

      is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId

      is always an empty string.'
  ServicePlacementPolicyDescriptionList:
    type: array
    items:
      $ref: '#/definitions/ServicePlacementPolicyDescription'
    description: List of service placement policy descriptions.
  ServicePlacementPolicyDescription:
    discriminator: Type
    description: Describes the policy to be used for placement of a Service Fabric service.
    required:
    - Type
    properties:
      Type:
        $ref: '#/definitions/ServicePlacementPolicyType'
        description: The type of placement policy for a service fabric service. Following are the possible values.
  DeployedServiceTypeInfoList:
    type: array
    items:
      $ref: '#/definitions/DeployedServiceTypeInfo'
    description: List of information about service type deployed on a node.
  ServiceLoadMetricsList:
    type: array
    items:
      $ref: '#/definitions/ServiceLoadMetricDescription'
    description: The service load metrics is given as an array of ServiceLoadMetricDescription objects.
  CodePackageName:
    type: string
    description: The name of the code package defined in the service manifest.
  ServiceTypeManifest:
    description: Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.
    properties:
      Manifest:
        type: string
        description: The XML manifest as a string.
  ServiceTypeName:
    type: string
    description: Name of the service type as specified in the service manifest.
  ServiceManifestName:
    type: string
    description: The name of the service manifest.
  ServiceTypeExtensionDescriptionList:
    type: array
    items:
      $ref: '#/definitions/ServiceTypeExtensionDescription'
    description: List of service type extensions.
  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:
      - value: Zero
        description: Disables resource balancing for this metric. This value is zero.
      - value: Low
        description: Specifies the metric weight of the service load as Low. The value is 1.
      - value: Medium
        description: Specifies the metric weight of the service load as Medium. The value is 2.
      - value: High
        description: Specifies the metric weight of the service load as High. The value is 3.
  ServiceKind:
    type: string
    description: The kind of service (Stateless or Stateful).
    enum:
    - Invalid
    - Stateless
    - Stateful
    x-ms-enum:
      name: ServiceKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Stateless
        description: Does not use Service Fabric to make its state highly available or reliable. The value is 1.
      - value: Stateful
        description: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2.
  FabricErrorCodes:
    type: string
    description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n  - Possible values of the error code for HTTP status code 400 (Bad Request)\n    - \"FABRIC_E_INVALID_PARTITION_KEY\"\n    - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_ADDRESS\"\n    - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n    - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_CONFIGURATION\"\n    - \"FABRIC_E_INVALID_NAME_URI\"\n    - \"FABRIC_E_PATH_TOO_LONG\"\n    - \"FABRIC_E_KEY_TOO_LARGE\"\n    - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n    - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n    - \"FABRIC_E_VALUE_EMPTY\"\n    - \"FABRIC_E_BACKUP_IS_ENABLED\"\n    - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n    - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n    - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n    - \"E_INVALIDARG\"\n\n  - Possible values of the error code for HTTP status code 404 (Not Found)\n    - \"FABRIC_E_NODE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n    - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n    - \"FABRIC_E_PARTITION_NOT_FOUND\"\n    - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n    - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n    - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n    - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n    - \"FABRIC_E_FILE_NOT_FOUND\"\n    - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n    - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n    - \"FABRIC_E_ENUMERATION_COMPLETED\"\n    - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n    - \"FABRIC_E_KEY_NOT_FOUND\"\n    - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n    - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n    - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n    - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n    - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n  - Possible values of the error code for HTTP status code 409 (Conflict)\n    - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n    - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n    - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n    - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n    - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n    - \"FABRIC_E_NAME_NOT_EMPTY\"\n    - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n    - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n    - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n    - \"FABRIC_E_HEALTH_STALE_REPORT\"\n    - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n    - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n    - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n    - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n    - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n    - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n  - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n    - \"FABRIC_E_NODE_IS_UP\"\n    - \"E_FAIL\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n    - \"FABRIC_E_VOLUME_NOT_FOUND\"\n    - \"SerializationError\"\n\n  - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n    - \"FABRIC_E_NO_WRITE_QUORUM\"\n    - \"FABRIC_E_NOT_PRIMARY\"\n    - \"FABRIC_E_NOT_READY\"\n    - \"FABRIC_E_RECONFIGURATION_PENDING\"\n    - \"FABRIC_E_SERVICE_OFFLINE\"\n    - \"E_ABORT\"\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n    - \"FABRIC_E_COMMUNICATION_ERROR\"\n    - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n    - \"FABRIC_E_TIMEOUT\""
    enum:
    - FABRIC_E_INVALID_PARTITION_KEY
    - FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
    - FABRIC_E_INVALID_ADDRESS
    - FABRIC_E_APPLICATION_NOT_UPGRADING
    - FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
    - FABRIC_E_FABRIC_NOT_UPGRADING
    - FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
    - FABRIC_E_INVALID_CONFIGURATION
    - FABRIC_E_INVALID_NAME_URI
    - FABRIC_E_PATH_TOO_LONG
    - FABRIC_E_KEY_TOO_LARGE
    - FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
    - FABRIC_E_INVALID_ATOMIC_GROUP
    - FABRIC_E_VALUE_EMPTY
    - FABRIC_E_NODE_NOT_FOUND
    - FABRIC_E_APPLICATION_TYPE_NOT_FOUND
    - FABRIC_E_APPLICATION_NOT_FOUND
    - FABRIC_E_SERVICE_TYPE_NOT_FOUND
    - FABRIC_E_SERVICE_DOES_NOT_EXIST
    - FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
    - FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
    - FABRIC_E_PARTITION_NOT_FOUND
    - FABRIC_E_REPLICA_DOES_NOT_EXIST
    - FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
    - FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
    - FABRIC_E_DIRECTORY_NOT_FOUND
    - FABRIC_E_FABRIC_VERSION_NOT_FOUND
    - FABRIC_E_FILE_NOT_FOUND
    - FABRIC_E_NAME_DOES_NOT_EXIST
    - FABRIC_E_PROPERTY_DOES_NOT_EXIST
    - FABRIC_E_ENUMERATION_COMPLETED
    - FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
    - FABRIC_E_KEY_NOT_FOUND
    - FABRIC_E_HEALTH_ENTITY_NOT_FOUND
    - FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
    - FABRIC_E_APPLICATION_ALREADY_EXISTS
    - FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
    - FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
    - FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
    - FABRIC_E_SERVICE_ALREADY_EXISTS
    - FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
    - FABRIC_E_APPLICATION_TYPE_IN_USE
    - FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
    - FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
    - FABRIC_E_FABRIC_VERSION_IN_USE
    - FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
    - FABRIC_E_NAME_ALREADY_EXISTS
    - FABRIC_E_NAME_NOT_EMPTY
    - FABRIC_E_PROPERTY_CHECK_FAILED
    - FABRIC_E_SERVICE_METADATA_MISMATCH
    - FABRIC_E_SERVICE_TYPE_MISMATCH
    - FABRIC_E_HEALTH_STALE_REPORT
    - FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
    - FABRIC_E_NODE_HAS_NOT_STOPPED_YET
    - FABRIC_E_INSTANCE_ID_MISMATCH
    - FABRIC_E_VALUE_TOO_LARGE
    - FABRIC_E_NO_WRITE_QUORUM
    - FABRIC_E_NOT_PRIMARY
    - FABRIC_E_NOT_READY
    - FABRIC_E_RECONFIGURATION_PENDING
    - FABRIC_E_SERVICE_OFFLINE
    - E_ABORT
    - FABRIC_E_COMMUNICATION_ERROR
    - FABRIC_E_OPERATION_NOT_COMPLETE
    - FABRIC_E_TIMEOUT
    - FABRIC_E_NODE_IS_UP
    - E_FAIL
    - FABRIC_E_BACKUP_IS_ENABLED
    - FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
    - FABRIC_E_INVALID_FOR_STATELESS_SERVICES
    - FABRIC_E_BACKUP_NOT_ENABLED
    - FABRIC_E_BACKUP_POLICY_NOT_EXISTING
    - FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
    - FABRIC_E_BACKUP_IN_PROGRESS
    - FABRIC_E_RESTORE_IN_PROGRESS
    - FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
    - FABRIC_E_INVALID_SERVICE_SCALING_POLICY
    - E_INVALIDARG
    - FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
    - FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
    - FABRIC_E_VOLUME_ALREADY_EXISTS
    - FABRIC_E_VOLUME_NOT_FOUND
    - SerializationError
    - FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
    x-ms-enum:
      name: FabricErrorCodes
      modelAsString: true
      values:
      - value: FABRIC_E_INVALID_PARTITION_KEY
      - value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
      - value: FABRIC_E_INVALID_ADDRESS
      - value: FABRIC_E_APPLICATION_NOT_UPGRADING
      - value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
      - value: FABRIC_E_FABRIC_NOT_UPGRADING
      - value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
      - value: FABRIC_E_INVALID_CONFIGURATION
      - value: FABRIC_E_INVALID_NAME_URI
      - value: FABRIC_E_PATH_TOO_LONG
      - value: FABRIC_E_KEY_TOO_LARGE
      - value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
      - value: FABRIC_E_INVALID_ATOMIC_GROUP
      - value: FABRIC_E_VALUE_EMPTY
      - value: FABRIC_E_NODE_NOT_FOUND
      - value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND
      - value: FABRIC_E_APPLICATION_NOT_FOUND
      - value: FABRIC_E_SERVICE_TYPE_NOT_FOUND
      - value: FABRIC_E_SERVICE_DOES_NOT_EXIST
      - value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
      - value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
      - value: FABRIC_E_PARTITION_NOT_FOUND
      - value: FABRIC_E_REPLICA_DOES_NOT_EXIST
      - value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
      - value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
      - value: FABRIC_E_DIRECTORY_NOT_FOUND
      - value: FABRIC_E_FABRIC_VERSION_NOT_FOUND
      - value: FABRIC_E_FILE_NOT_FOUND
      - value: FABRIC_E_NAME_DOES_NOT_EXIST
      - value: FABRIC_E_PROPERTY_DOES_NOT_EXIST
      - value: FABRIC_E_ENUMERATION_COMPLETED
      - value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
      - value: FABRIC_E_KEY_NOT_FOUND
      - value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND
      - value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
      - value: FABRIC_E_APPLICATION_ALREADY_EXISTS
      - value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
      - value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
      - value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
      - value: FABRIC_E_SERVICE_ALREADY_EXISTS
      - value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
      - value: FABRIC_E_APPLICATION_TYPE_IN_USE
      - value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
      - value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
      - value: FABRIC_E_FABRIC_VERSION_IN_USE
      - value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
      - value: FABRIC_E_NAME_ALREADY_EXISTS
      - value: FABRIC_E_NAME_NOT_EMPTY
      - value: FABRIC_E_PROPERTY_CHECK_FAILED
      - value: FABRIC_E_SERVICE_METADATA_MISMATCH
      - value: FABRIC_E_SERVICE_TYPE_MISMATCH
      - value: FABRIC_E_HEALTH_STALE_REPORT
      - value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
      - value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET
      - value: FABRIC_E_INSTANCE_ID_MISMATCH
      - value: FABRIC_E_VALUE_TOO_LARGE
      - value: FABRIC_E_NO_WRITE_QUORUM
      - value: FABRIC_E_NOT_PRIMARY
      - value: FABRIC_E_NOT_READY
      - value: FABRIC_E_RECONFIGURATION_PENDING
      - value: FABRIC_E_SERVICE_OFFLINE
      - value: E_ABORT
      - value: FABRIC_E_COMMUNICATION_ERROR
      - value: FABRIC_E_OPERATION_NOT_COMPLETE
      - value: FABRIC_E_TIMEOUT
      - value: FABRIC_E_NODE_IS_UP
      - value: E_FAIL
      - value: FABRIC_E_BACKUP_IS_ENABLED
      - value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
      - value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES
      - value: FABRIC_E_BACKUP_NOT_ENABLED
      - value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING
      - value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
      - value: FABRIC_E_BACKUP_IN_PROGRESS
      - value: FABRIC_E_RESTORE_IN_PROGRESS
      - value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
      - value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY
      - value: E_INVALIDARG
      - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
      - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
      - value: FABRIC_E_VOLUME_ALREADY_EXISTS
      - value: FABRIC_E_VOLUME_NOT_FOUND
      - value: SerializationError
      - value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
  ServiceTypeDescription:
    discriminator: Kind
    description: Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.
    required:
    - Kind
    properties:
      Kind:
        $ref: '#/definitions/ServiceKind'
        description: The kind of service (Stateless or Stateful).
      IsStateful:
        type: boolean
        description: Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
      ServiceTypeName:
        $ref: '#/definitions/ServiceTypeName'
        description: Name of the service type as specified in the service manifest.
      PlacementConstraints:
        type: string
        description: The placement constraint to be used when instantiating this service in a Service Fabric cluster.
      LoadMetrics:
        $ref: '#/definitions/ServiceLoadMetricsList'
        description: The service load metrics is given as an array of ServiceLoadMetricDescription objects.
      ServicePlacementPolicies:
        $ref: '#/definitions/ServicePlacementPolicyDescriptionList'
        description: List of service placement policy descriptions.
      Extensions:
        $ref: '#/definitions/ServiceTypeExtensionDescriptionList'
        description: List of service type extensions.
  FabricError:
    description: The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.
    properties:
      Error:
        $ref: '#/definitions/FabricErrorError'
        description: Error object containing error cod

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-servicetype-api-openapi.yml
Microsoft Azure ServiceType API

Documentation

Specifications

Other Resources

OpenAPI Specification
