openapi-directory/api/azure.com/servicefabric.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.","title":"Service Fabric Client APIs","version":"6.5.0.36","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.5/servicefabric.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"servicefabric","x-tags":["Azure","Microsoft"]},"paths":{"/$/CancelRepairTask":{"post":{"description":"This API supports the Service Fabric platform; it is not meant to be used directly from your code.","operationId":"CancelRepairTask","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskCancelDescription"}}},"description":"Describes the repair task to be cancelled.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.\nSuccess indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled.\nClients may use the State property of the repair task to determine the current state of the repair task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskUpdateInfo"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Requests the cancellation of the given repair task.","tags":["RepairManagement"]}},"/$/CreateRepairTask":{"post":{"description":"For clusters that have the Repair Manager Service configured,\nthis API provides a way to create repair tasks that run automatically or manually.\nFor repair tasks that run automatically, an appropriate repair executor\nmust be running for each repair action to run automatically.\nThese are currently only available in specially-configured Azure Cloud Services.\n\nTo create a manual repair task, provide the set of impacted node names and the\nexpected impact. When the state of the created repair task changes to approved,\nyou can safely perform repair actions on those nodes.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.","operationId":"CreateRepairTask","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"}],"requestBody":{"$ref":"#/components/requestBodies/RepairTask"},"responses":{"200":{"description":"A successful operation will return 200 status code.\nThe response body provides information about the created repair task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskUpdateInfo"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Creates a new repair task.","tags":["RepairManagement"]}},"/$/DeleteRepairTask":{"post":{"description":"This API supports the Service Fabric platform; it is not meant to be used directly from your code.","operationId":"DeleteRepairTask","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskDeleteDescription"}}},"description":"Describes the repair task to be deleted.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful operation will return 200 status code."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Deletes a completed repair task.","tags":["RepairManagement"]}},"/$/ForceApproveRepairTask":{"post":{"description":"This API supports the Service Fabric platform; it is not meant to be used directly from your code.","operationId":"ForceApproveRepairTask","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskApproveDescription"}}},"description":"Describes the repair task to be approved.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskUpdateInfo"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Forces the approval of the given repair task.","tags":["RepairManagement"]}},"/$/GetAadMetadata":{"get":{"description":"Gets the Azure Active Directory metadata used for secured connection to cluster.\nThis 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.","operationId":"GetAadMetadata","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 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"}}}}},"summary":"Gets the Azure Active Directory metadata used for secured connection to cluster.","tags":["Cluster"]}},"/$/GetClusterConfiguration":{"get":{"description":"The cluster configuration contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.","operationId":"GetClusterConfiguration","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"}}}}},"summary":"Get the Service Fabric standalone cluster configuration.","tags":["Cluster"]}},"/$/GetClusterConfigurationUpgradeStatus":{"get":{"description":"Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.","operationId":"GetClusterConfigurationUpgradeStatus","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 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"}}}}},"summary":"Get the cluster configuration upgrade status of a Service Fabric standalone cluster.","tags":["Cluster"]}},"/$/GetClusterHealth":{"get":{"description":"Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.","operationId":"GetClusterHealth","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"}],"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"}}}}},"summary":"Gets the health of a Service Fabric cluster.","tags":["Cluster"]},"post":{"description":"Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.\nUse ClusterHealthPolicies to override the health policies used to evaluate the health.","operationId":"GetClusterHealthUsingPolicy","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"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterHealthPolicies"}}},"description":"Describes the health policies used to evaluate the cluster health.\nIf not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.","x-ms-parameter-location":"method"},"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"}}}}},"summary":"Gets the health of a Service Fabric cluster using the specified policy.","tags":["Cluster"]}},"/$/GetClusterHealthChunk":{"get":{"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.\nTo 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.","operationId":"GetClusterHealthChunk","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 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"}}}}},"summary":"Gets the health of a Service Fabric cluster using health chunks.","tags":["Cluster"]},"post":{"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.\nThe query description allows users to specify health policies for evaluating the cluster and its children.\nUsers 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.\nThe 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\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.","operationId":"GetClusterHealthChunkUsingPolicyAndAdvancedFilters","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterHealthChunkQueryDescription"}}},"description":"Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned.\nIf the cluster health policy is present, it is used to evaluate the cluster events and the cluster nodes. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.\nUsers can specify very flexible filters to select which cluster entities to include in response. The selection can be done based on the entities health state and based on the hierarchy.\nThe 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\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.","x-ms-parameter-location":"method"},"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"}}}}},"summary":"Gets the health of a Service Fabric cluster using health chunks.","tags":["Cluster"]}},"/$/GetClusterManifest":{"get":{"description":"Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.\n\nThese 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\nis generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal).\n\nThe 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.","operationId":"GetClusterManifest","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"}}}}},"summary":"Get the Service Fabric cluster manifest.","tags":["Cluster"]}},"/$/GetClusterVersion":{"get":{"description":"If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions.","operationId":"GetClusterVersion","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-4_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"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"},"examples":{"Get cluster version":{"$ref":"#/components/examples/Get_cluster_version"}}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Get the current Service Fabric cluster version.","tags":["Cluster"]}},"/$/GetLoadInformation":{"get":{"description":"Retrieves the load information of a Service Fabric cluster for all the metrics that have load or capacity defined.","operationId":"GetClusterLoad","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"}}}}},"summary":"Gets the load of a Service Fabric cluster.","tags":["Cluster"]}},"/$/GetProvisionedCodeVersions":{"get":{"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.","operationId":"GetProvisionedFabricCodeVersionInfoList","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/CodeVersionOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"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"}}}}},"summary":"Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.","tags":["Cluster"]}},"/$/GetProvisionedConfigVersions":{"get":{"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.","operationId":"GetProvisionedFabricConfigVersionInfoList","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/ConfigVersionOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"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"}}}}},"summary":"Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.","tags":["Cluster"]}},"/$/GetRepairTaskList":{"get":{"description":"This API supports the Service Fabric platform; it is not meant to be used directly from your code.","operationId":"GetRepairTaskList","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/RepairTaskIdFilterOptionalQueryParam"},{"$ref":"#/components/parameters/RepairTaskStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/RepairTaskExecutorFilterOptionalQueryParam"}],"responses":{"200":{"description":"A successful operation will return 200 status code.\nThe response body provides a list of repair tasks matching all of the given filters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskList"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets a list of repair tasks matching the given filters.","tags":["RepairManagement"]}},"/$/GetUpgradeOrchestrationServiceState":{"get":{"description":"Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.","operationId":"GetUpgradeOrchestrationServiceState","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"}}}}},"summary":"Get the service state of Service Fabric Upgrade Orchestration Service.","tags":["Cluster"]}},"/$/GetUpgradeProgress":{"get":{"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.","operationId":"GetClusterUpgradeProgress","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 upgrade progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterUpgradeProgressObject"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the progress of the current cluster upgrade.","tags":["Cluster"]}},"/$/InvokeInfrastructureCommand":{"post":{"description":"For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific commands to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.","operationId":"InvokeInfrastructureCommand","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/InfrastructureCommandRequiredQueryParam"},{"$ref":"#/components/parameters/InfrastructureServiceIdOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfrastructureServiceResponse"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Invokes an administrative command on the given Infrastructure Service instance.","tags":["Infrastructure"]}},"/$/InvokeInfrastructureQuery":{"get":{"description":"For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific queries to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.","operationId":"InvokeInfrastructureQuery","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/InfrastructureCommandRequiredQueryParam"},{"$ref":"#/components/parameters/InfrastructureServiceIdOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfrastructureServiceResponse"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Invokes a read-only query on the given infrastructure service instance.","tags":["Infrastructure"]}},"/$/MoveToNextUpgradeDomain":{"post":{"description":"Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.","operationId":"ResumeClusterUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumeClusterUpgradeDescription"}}},"description":"Describes the parameters for resuming a cluster upgrade.","required":true,"x-ms-parameter-location":"method"},"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"}}}}},"summary":"Make the cluster upgrade move on to the next upgrade domain.","tags":["Cluster"]}},"/$/Provision":{"post":{"description":"Validate and provision the code or configuration packages of a Service Fabric cluster.","operationId":"ProvisionCluster","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisionFabricDescription"}}},"description":"Describes the parameters for provisioning a cluster.","required":true,"x-ms-parameter-location":"method"},"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"}}}}},"summary":"Provision the code or configuration packages of a Service Fabric cluster.","tags":["Cluster"]}},"/$/RecoverAllPartitions":{"post":{"description":"This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.","operationId":"RecoverAllPartitions","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"A successful operation request will return 200 status code."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.","tags":["Partition"]}},"/$/RecoverSystemPartitions":{"post":{"description":"Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.","operationId":"RecoverSystemPartitions","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"A successful operation request will return 200 status code."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.","tags":["Partition"]}},"/$/ReportClusterHealth":{"post":{"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.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.","operationId":"ReportClusterHealth","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/ImmediateOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"$ref":"#/components/requestBodies/HealthInformation"},"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"}}}}},"summary":"Sends a health report on the Service Fabric cluster.","tags":["Cluster"]}},"/$/RollbackUpgrade":{"post":{"description":"Roll back the code or configuration upgrade of a Service Fabric cluster.","operationId":"RollbackClusterUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"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"}}}}},"summary":"Roll back the upgrade of a Service Fabric cluster.","tags":["Cluster"]}},"/$/SetUpgradeOrchestrationServiceState":{"post":{"description":"Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.","operationId":"SetUpgradeOrchestrationServiceState","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeOrchestrationServiceState"}}},"description":"Service state of Service Fabric Upgrade Orchestration Service.","required":true,"x-ms-parameter-location":"method"},"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"}}}}},"summary":"Update the service state of Service Fabric Upgrade Orchestration Service.","tags":["Cluster"]}},"/$/StartClusterConfigurationUpgrade":{"post":{"description":"Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.","operationId":"StartClusterConfigurationUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterConfigurationUpgradeDescription"}}},"description":"Parameters for a standalone cluster configuration upgrade.","required":true,"x-ms-parameter-location":"method"},"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"}}}}},"summary":"Start upgrading the configuration of a Service Fabric standalone cluster.","tags":["Cluster"]}},"/$/ToggleVerboseServicePlacementHealthReporting":{"post":{"description":"If verbosity is set to true, then detailed health reports will be generated when replicas cannot be placed or dropped.\nIf verbosity is set to false, then no health reports will be generated when replicas cannot be placed or dropped.","operationId":"ToggleVerboseServicePlacementHealthReporting","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"}}}}},"summary":"Changes the verbosity of service placement health reporting.","tags":["Cluster"]}},"/$/Unprovision":{"post":{"description":"It is supported to unprovision code and configuration separately.","operationId":"UnprovisionCluster","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprovisionFabricDescription"}}},"description":"Describes the parameters for unprovisioning a cluster.","required":true,"x-ms-parameter-location":"method"},"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"}}}}},"summary":"Unprovision the code or configuration packages of a Service Fabric cluster.","tags":["Cluster"]}},"/$/UpdateRepairExecutionState":{"post":{"description":"This API supports the Service Fabric platform; it is not meant to be used directly from your code.","operationId":"UpdateRepairExecutionState","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"}],"requestBody":{"$ref":"#/components/requestBodies/RepairTask"},"responses":{"200":{"description":"A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskUpdateInfo"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Updates the execution state of a repair task.","tags":["RepairManagement"]}},"/$/UpdateRepairTaskHealthPolicy":{"post":{"description":"This API supports the Service Fabric platform; it is not meant to be used directly from your code.","operationId":"UpdateRepairTaskHealthPolicy","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskUpdateHealthPolicyDescription"}}},"description":"Describes the repair task healthy policy to be updated.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepairTaskUpdateInfo"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Updates the health policy of the given repair task.","tags":["RepairManagement"]}},"/$/UpdateUpgrade":{"post":{"description":"Update the upgrade parameters used during a Service Fabric cluster upgrade.","operationId":"UpdateClusterUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClusterUpgradeDescription"}}},"description":"Parameters for updating a cluster upgrade.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful operation returns 200 status code."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Update the upgrade parameters of a Service Fabric cluster upgrade.","tags":["Cluster"]}},"/$/Upgrade":{"post":{"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":"StartClusterUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClusterUpgradeDescription"}}},"description":"Describes the parameters for starting a cluster upgrade.","required":true,"x-ms-parameter-location":"method"},"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"}}}}},"summary":"Start upgrading the code or configuration version of a Service Fabric cluster.","tags":["Cluster"]}},"/ApplicationTypes":{"get":{"description":"Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.","operationId":"GetApplicationTypeInfoList","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationTypeDefinitionKindFilterOptionalQueryParam"},{"$ref":"#/components/parameters/ExcludeApplicationParametersOptionalQueryParam"},{"$ref":"#/components/parameters/ContinuationTokenOptionalQueryParam"},{"$ref":"#/components/parameters/MaxResultsOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"List of application types in the cluster.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedApplicationTypeInfoList"},"examples":{"Exclude application parameters from the result":{"$ref":"#/components/examples/Exclude_application_parameters_from_the_result"},"Limit maximum results":{"$ref":"#/components/examples/Limit_maximum_results"},"Page using continuation token":{"$ref":"#/components/examples/Page_using_continuation_token"}}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the list of application types in the Service Fabric cluster.","tags":["ApplicationType"]}},"/ApplicationTypes/$/Provision":{"post":{"description":"Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated.\nThe provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'.","operationId":"ProvisionApplicationType","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-2_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisionApplicationTypeDescriptionBase"}}},"description":"The base type of provision application type description which supports either image store-based provision or external store-based provision.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful provision will return 200 status code."},"202":{"description":"A 202 status code indicates the operation was accepted and the provision operation has been initiated."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store.","tags":["ApplicationType"]}},"/ApplicationTypes/{applicationTypeName}":{"get":{"description":"Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. All versions of the application type matching the application type name are returned, with each version returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.","operationId":"GetApplicationTypeInfoListByName","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationTypeNameRequiredPathParam"},{"$ref":"#/components/parameters/ApplicationTypeVersionOptionalQueryParam"},{"$ref":"#/components/parameters/ExcludeApplicationParametersOptionalQueryParam"},{"$ref":"#/components/parameters/ContinuationTokenOptionalQueryParam"},{"$ref":"#/components/parameters/MaxResultsOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"List of application types in the cluster.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedApplicationTypeInfoList"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the list of application types in the Service Fabric cluster matching exactly the specified name.","tags":["ApplicationType"]}},"/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest":{"get":{"description":"The response contains the application manifest XML as a string.","operationId":"GetApplicationManifest","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationTypeNameRequiredPathParam"},{"$ref":"#/components/parameters/ApplicationTypeVersionRequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"Information about the node.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationTypeManifest"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the manifest describing an application type.","tags":["ApplicationType"]}},"/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest":{"get":{"description":"Gets the manifest describing a service type. The response contains the service manifest XML as a string.","operationId":"GetServiceManifest","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationTypeNameRequiredPathParam"},{"$ref":"#/components/parameters/ApplicationTypeVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ServiceManifestNameRequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"Information about the service type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceTypeManifest"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the manifest describing a service type.","tags":["ServiceType"]}},"/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes":{"get":{"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":"GetServiceTypeInfoList","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationTypeNameRequiredPathParam"},{"$ref":"#/components/parameters/ApplicationTypeVersionRequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"List of service types that are supported by a provisioned application type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceTypeInfoList"},"examples":{"Get information about all nodes.":{"$ref":"#/components/examples/Get_information_about_all_nodes."}}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.","tags":["ServiceType"]}},"/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}":{"get":{"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":"GetServiceTypeInfoByName","parameters":[{"$ref":"#/components/parameters/ApiVersion_6-0_RequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationTypeNameRequiredPathParam"},{"$ref":"#/components/parameters/ApplicationTypeVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ServiceTypeNameRequiredPathParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"A specific service type which supported by a provisioned application type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceTypeInfo"},"examples":{"Get information about all nodes.":{"$ref":"#/components/examples/Get_information_about_all_nodes."}}}}},"204":{"description":"A 204 response is returned if the specified service type is not found in the cluster."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the information about a specific service type that is supported by a provisioned application type in a Se