Microsoft Azure Cluster API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Cluster API
tags:
- name: Cluster
paths:
  /$/GetClusterManifest:
    get:
      operationId: microsoftAzureGetclustermanifest
      summary: Microsoft Azure Get The Service Fabric Cluster Manifest
      description: Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster,<br>security configurations, fault, and upgrade domain topologies, etc.<br><br>These properties are specified as part of the ClusterConfig.JSON file while deploying a stand-alone cluster. However, most of the information in the cluster manifest<br>is generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal).<br><br>The contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.
      tags:
      - Cluster
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster manifest information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterManifest'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetClusterHealth:
    get:
      operationId: microsoftAzureGetclusterhealth
      summary: Microsoft Azure Gets The Health Of A Service Fabric Cluster
      description: Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.<br>Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/NodesHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/ApplicationsHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/components/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster health information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterHealth'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
    post:
      operationId: microsoftAzureGetclusterhealthusingpolicy
      summary: Microsoft Azure Gets The Health Of A Service Fabric Cluster Using The Specified Policy
      description: Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.<br>Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.<br>Use ClusterHealthPolicies to override the health policies used to evaluate the health.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/NodesHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/ApplicationsHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/components/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam'
      - $ref: '#/components/parameters/ClusterHealthPoliciesOptionalBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster health information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterHealth'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetClusterHealthChunk:
    get:
      operationId: microsoftAzureGetclusterhealthchunk
      summary: Microsoft Azure Gets The Health Of A Service Fabric Cluster Using Health Chunks
      description: Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities.<br>To expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster health chunk information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterHealthChunk'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
    post:
      operationId: microsoftAzureGetclusterhealthchunkusingpolicyandadvancedfilters
      summary: Microsoft Azure Gets The Health Of A Service Fabric Cluster Using Health Chunks
      description: Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description.<br>The query description allows users to specify health policies for evaluating the cluster and its children.<br>Users can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy.<br>The query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return<br>only services that are in Error or Warning, and all partitions and replicas for one of these services.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ClusterHealthChunkQueryDescriptionOptionalBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster health chunk information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterHealthChunk'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/ReportClusterHealth:
    post:
      operationId: microsoftAzureReportclusterhealth
      summary: Microsoft Azure Sends A Health Report On The Service Fabric Cluster
      description: Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported.<br>The report is sent to a Service Fabric gateway node, which forwards to the health store.<br>The report may be accepted by the gateway, but rejected by the health store after extra validation.<br>For example, the health store may reject the report because of an invalid parameter, like a stale sequence number.<br>To see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/HealthInformationRequiredBodyParam'
      - $ref: '#/components/parameters/ImmediateOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code when the cluster health report is accepted for processing.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetProvisionedCodeVersions:
    get:
      operationId: microsoftAzureGetprovisionedfabriccodeversioninfolist
      summary: Microsoft Azure Gets A List Of Fabric Code Versions That Are Provisioned In A Service Fabric Cluster
      description: Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/CodeVersionOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested provisioned code versions information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricCodeVersionInfoList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetProvisionedConfigVersions:
    get:
      operationId: microsoftAzureGetprovisionedfabricconfigversioninfolist
      summary: Microsoft Azure Gets A List Of Fabric Config Versions That Are Provisioned In A Service Fabric Cluster
      description: Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ConfigVersionOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested provisioned config versions information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricConfigVersionInfoList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetUpgradeProgress:
    get:
      operationId: microsoftAzureGetclusterupgradeprogress
      summary: Microsoft Azure Gets The Progress Of The Current Cluster Upgrade
      description: Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster upgrade progress.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterUpgradeProgressObject'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetClusterConfiguration:
    get:
      operationId: microsoftAzureGetclusterconfiguration
      summary: Microsoft Azure Get The Service Fabric Standalone Cluster Configuration
      description: The cluster configuration contains properties of the cluster that include different node types on the cluster,<br>security configurations, fault, and upgrade domain topologies, etc.
      tags:
      - Cluster
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ConfigurationApiVersionRequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster configuration information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterConfiguration'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetClusterConfigurationUpgradeStatus:
    get:
      operationId: microsoftAzureGetclusterconfigurationupgradestatus
      summary: Microsoft Azure Get The Cluster Configuration Upgrade Status Of A Service Fabric Standalone Cluster
      description: Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster configuration upgrade status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterConfigurationUpgradeStatusInfo'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetUpgradeOrchestrationServiceState:
    get:
      operationId: microsoftAzureGetupgradeorchestrationservicestate
      summary: Microsoft Azure Get The Service State Of Service Fabric Upgrade Orchestration Service
      description: Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.
      tags:
      - Cluster
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested service state of Service Fabric Upgrade Orchestration Service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeOrchestrationServiceState'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/SetUpgradeOrchestrationServiceState:
    post:
      operationId: microsoftAzureSetupgradeorchestrationservicestate
      summary: Microsoft Azure Update The Service State Of Service Fabric Upgrade Orchestration Service
      description: Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.
      tags:
      - Cluster
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/UpgradeOrchestrationServiceStateRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful response means that the service state of Service Fabric Upgrade Orchestration Service has been updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeOrchestrationServiceStateSummary'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/Provision:
    post:
      summary: Microsoft Azure Provision The Code Or Configuration Packages Of A Service Fabric Cluster
      description: Validate and provision the code or configuration packages of a Service Fabric cluster.
      operationId: microsoftAzureProvisioncluster
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ProvisionFabricDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful response means that the code or configuration packages have been provisioned.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/Unprovision:
    post:
      summary: Microsoft Azure Unprovision The Code Or Configuration Packages Of A Service Fabric Cluster
      description: It is supported to unprovision code and configuration separately.
      operationId: microsoftAzureUnprovisioncluster
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/UnprovisionFabricDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful response means that the code or configuration packages have been unprovisioned.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/RollbackUpgrade:
    post:
      summary: Microsoft Azure Roll Back The Upgrade Of A Service Fabric Cluster
      description: Roll back the code or configuration upgrade of a Service Fabric cluster.
      operationId: microsoftAzureRollbackclusterupgrade
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '202':
          description: A successful response means that the rollback of a cluster upgrade has been initiated.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/MoveToNextUpgradeDomain:
    post:
      summary: Microsoft Azure Make The Cluster Upgrade Move On To The Next Upgrade Domain
      description: Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.
      operationId: microsoftAzureResumeclusterupgrade
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ResumeClusterUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful response means that the cluster upgrade has moved on to the next upgrade domain.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/Upgrade:
    post:
      summary: Microsoft Azure Start Upgrading The Code Or Configuration Version Of A Service Fabric Cluster
      description: Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.
      operationId: microsoftAzureStartclusterupgrade
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/StartClusterUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '202':
          description: A successful response means that the cluster code or configuration upgrade has started. Use GetUpgradeProgress operation to get the status of the upgrade.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/StartClusterConfigurationUpgrade:
    post:
      summary: Microsoft Azure Start Upgrading The Configuration Of A Service Fabric Standalone Cluster
      description: Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.
      operationId: microsoftAzureStartclusterconfigurationupgrade
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ClusterConfigurationUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      x-ms-examples:
        Start upgrading the configuration of a Service Fabric standalone cluster:
          $ref: ./examples/StartClusterConfigurationUpgrade-1.json
      responses:
        '202':
          description: A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/UpdateUpgrade:
    post:
      operationId: microsoftAzureUpdateclusterupgrade
      summary: Microsoft Azure Update The Upgrade Parameters Of A Service Fabric Cluster Upgrade
      description: Update the upgrade parameters used during a Service Fabric cluster upgrade.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/UpdateClusterUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation returns 200 status code.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetAadMetadata:
    get:
      operationId: microsoftAzureGetaadmetadata
      summary: Microsoft Azure Gets The Azure Active Directory Metadata Used For Secured Connection To Cluster
      description: Gets the Azure Active Directory metadata used for secured connection to cluster.<br>This API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the Azure Active Directory metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AadMetadataObject'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetClusterVersion:
    get:
      operationId: microsoftAzureGetclusterversion
      summary: Microsoft Azure Get The Current Service Fabric Cluster Version
      description: If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions.
      tags:
      - Cluster
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      x-ms-examples:
        Get cluster version:
          $ref: ./examples/GetClusterVersion-1.json
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster version information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterVersion'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/GetLoadInformation:
    get:
      operationId: microsoftAzureGetclusterload
      summary: Microsoft Azure Gets The Load Of A Service Fabric Cluster
      description: Retrieves the load information of a Service Fabric cluster for all the metrics that have load or capacity defined.
      tags:
      - Cluster
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster load information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterLoadInfo'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/ToggleVerboseServicePlacementHealthReporting:
    post:
      operationId: microsoftAzureToggleverboseserviceplacementhealthreporting
      summary: Microsoft Azure Changes The Verbosity Of Service Placement Health Reporting
      description: If verbosity is set to true, then detailed health reports will be generated when replicas cannot be placed or dropped.<br>If verbosity is set to false, then no health reports will be generated when replicas cannot be placed or dropped.
      tags:
      - Cluster
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/VerboseServicePlacementHealthReportingParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful response means that the verbosity of service placement health reporting was updated.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /$/ValidateUpgrade:
    post:
      summary: Microsoft Azure Validate And Assess The Impact Of A Code Or Configuration Version Update Of A Service Fabric Cluster
      description: Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster. The upgrade will not be initiated.
      operationId: microsoftAzureValidateclusterupgrade
      parameters:
      - $ref: '#/components/parameters/ApiVersion_8-2_RequiredQueryParam'
      - $ref: '#/components/parameters/StartClusterUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful response means that the cluster code or configuration upgrade has valid parameters. The response body describes the assessed expected impact of the upgrade.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateClusterUpgradeResult'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
components:
  schemas:
    FabricConfigVersionInfo:
      description: Information about a Service Fabric config version.
      properties:
        ConfigVersion:
          description: The config version of Service Fabric.
          type: string
    UpgradeDomainTimeout:
      type: string
      description: The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      default: P10675199DT02H48M05.4775807S
    SafetyCheckWrapper:
      description: A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
      properties:
        SafetyCheck:
          $ref: '#/components/schemas/SafetyCheck'
          description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
    UpgradeType:
      type: string
      description: The type of upgrade out of the following possible values.
      default: Rolling
      enum:
      - Invalid
      - Rolling
      - Rolling_ForceRestart
      x-ms-enum:
        name: UpgradeType
        modelAsString: true
        values:
        - value: Invalid
          description: Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
        - value: Rolling
          description: The upgrade progresses one upgrade domain at a time. The value is 1.
        - value: Rolling_ForceRestart
          description: The upgrade gets restarted by force. The value is 2.
    ClusterFabricCodeVersionString:
      type: string
      description: The ServiceFabric code version of the cluster.
    PartitionHealthStateChunkList:
      description: 'The list of partition health state chunks that respect the input filters in the chunk query description.

        Returned by get cluster health state chunks query as part of the parent application hierarchy.'
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/PartitionHealthStateChunk'
          description: The list of partition health state chunks that respect the input filters in the chunk query.
    EntityKind:
      type: string
      description: The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      enum:
      - Invalid
      - Node
      - Partition
      - Service
      - Application
      - Replica
      - DeployedApplication
      - DeployedServicePackage
      - Cluster
      x-ms-enum:
        name: EntityKind
        modelAsString: true
        values:
        - value: Invalid
          description: Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero.
        - value: Node
          description: Indicates the entity is a Service Fabric node. The value is 1.
        - value: Partition
          description: Indicates the entity is a Service Fabric parti

# --- truncated at 32 KB (196 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-cluster-api-openapi.yml