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":"5.6.*","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/5.6/servicefabric.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"servicefabric","x-tags":["Azure","Microsoft"]},"paths":{"/$/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.\n","operationId":"GetAadMetadata","parameters":[{"$ref":"#/components/parameters/ApiVersion_1-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"]}},"/$/GetClusterHealth":{"get":{"description":"Gets the health of a Service Fabric cluster.\nUse 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.\n","operationId":"GetClusterHealth","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/NodesHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/ApplicationsHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/EventsHealthStateFilterOptionalQueryParam"},{"$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":"Gets the health of a Service Fabric cluster.\nUse 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. \n","operationId":"GetClusterHealthUsingPolicy","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/NodesHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/ApplicationsHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/EventsHealthStateFilterOptionalQueryParam"},{"$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.\n","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.\n","operationId":"GetClusterHealthChunk","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$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.\n","operationId":"GetClusterHealthChunkUsingPolicyAndAdvancedFilters","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$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.\n","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 (for e.g when using azuer 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.\n","operationId":"GetClusterManifest","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$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"]}},"/$/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/ApiVersionRequiredQueryParam"},{"$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/ApiVersionRequiredQueryParam"},{"$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"]}},"/$/GetUpgradeProgress":{"get":{"description":"Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, gets the last state of the previous cluster upgrade.","operationId":"GetClusterUpgradeProgress","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$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.\n","operationId":"InvokeInfrastructureCommand","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/InfrastructureCommandRequiredQueryParam"},{"$ref":"#/components/parameters/InfrastructureServiceIdOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"The response from the infrastructure service.\nThe response format is a JSON stream.\nThe contents of the response depend on which command was issued.\n","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"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.\n","operationId":"InvokeInfrastructureQuery","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/InfrastructureCommandRequiredQueryParam"},{"$ref":"#/components/parameters/InfrastructureServiceIdOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"The response from the infrastructure service.\nThe response format is a JSON stream.\nThe contents of the response depend on which command was issued.\n","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"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"]}},"/$/RecoverAllPartitions":{"post":{"description":"Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which 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":"RecoverAllPartitions","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$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 which 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/ApiVersionRequiredQueryParam"},{"$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 which 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.\n","operationId":"ReportClusterHealth","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$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"]}},"/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 3 application types, or if max results is set to 3, then 3 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_4-0_RequiredQueryParam"},{"$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"}}}}},"204":{"description":"An empty response is returned if there are no application types registered in the cluster matching the provided query parameters."},"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 or registers a Service Fabric application type with the cluster. This is required before any new applications can be instantiated.","operationId":"ProvisionApplicationType","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationTypeImageStorePath"}}},"description":"The relative path for the application package in the image store specified during the prior copy operation.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful provision will return 200 status code."},"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.","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 3 application types, or if max results is set to 3, then 3 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_4-0_RequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationTypeNameRequiredPathParam"},{"$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"}}}},"204":{"description":"An empty response is returned if there are no application types registered in the cluster matching the specified name and query parameters."},"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":"Gets the manifest describing an application type. The response contains the application manifest XML as a string.","operationId":"GetApplicationManifest","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$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/ApiVersionRequiredQueryParam"},{"$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 response includes the name of the service type, the name and version of the service manifest the type is defined in, kind (stateless or stateless) of the service type and other information about it.","operationId":"GetServiceTypeInfoList","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$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"}}}},"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}/$/Unprovision":{"post":{"description":"Removes or unregisters a Service Fabric application type from the cluster. This operation can only be performed if all application instance of the application type has been deleted. Once the application type is unregistered, no new application instance can be created for this particular application type.","operationId":"UnprovisionApplicationType","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationTypeNameRequiredPathParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationTypeImageStoreVersion"}}},"description":"The version of the application type in the image store.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful unprovision will return 200 status code."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Removes or unregisters a Service Fabric application type from the cluster.","tags":["ApplicationType"]}},"/Applications":{"get":{"description":"Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match filters specified as the parameter. The response includes the name, type, status, parameters and other details about the application. If the applications do not 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.","operationId":"GetApplicationInfoList","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationTypeNameOptionalQueryParam"},{"$ref":"#/components/parameters/ExcludeApplicationParametersOptionalQueryParam"},{"$ref":"#/components/parameters/ContinuationTokenOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"List of applications created in the cluster.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedApplicationInfoList"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the list of applications created in the Service Fabric cluster that match filters specified as the parameter.","tags":["Application"]}},"/Applications/$/Create":{"post":{"description":"Creates a Service Fabric application using the specified description.","operationId":"CreateApplication","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDescription"}}},"description":"Describes the application to be created.","required":true,"x-ms-parameter-location":"method"},"responses":{"201":{"description":"A successful response means that the application creation has been started. Use GetApplication operation to get the status of the application. Once GetApplicationInfo successfully returns application information, the application is created. If the application has default services those may be in the process of being created. Use GetServiceInfo operation to get the status of the service within the application."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Creates a Service Fabric application.","tags":["Application"]}},"/Applications/{applicationId}":{"get":{"description":"Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters and other details about the application.","operationId":"GetApplicationInfo","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/ExcludeApplicationParametersOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"Information about the application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInfo"}}}},"204":{"description":"An empty response is returned if the specified applicationId is not found in the cluster."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets information about a Service Fabric application.","tags":["Application"]}},"/Applications/{applicationId}/$/Delete":{"post":{"description":"Deletes an existing Service Fabric application. An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default Service Fabric will try to close service replicas in a graceful manner and then delete the service. However if service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of the its services.","operationId":"DeleteApplication","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/ForceRemoveOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"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 an existing Service Fabric application.","tags":["Application"]}},"/Applications/{applicationId}/$/GetHealth":{"get":{"description":"Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the helath store, it will return Error.","operationId":"GetApplicationHealth","parameters":[{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/EventsHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/ServicesHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"A successful operation will return 200 status code and the requested application health information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationHealth"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the health of the service fabric application.","tags":["Application"]},"post":{"description":"Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.","operationId":"GetApplicationHealthUsingPolicy","parameters":[{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/EventsHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/ServicesHealthStateFilterOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"$ref":"#/components/requestBodies/ApplicationHealthPolicy"},"responses":{"200":{"description":"A successful operation will return 200 status code and the requested node health information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationHealth"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the health of a Service Fabric application using the specified policy.","tags":["Application"]}},"/Applications/{applicationId}/$/GetServices":{"get":{"description":"Returns the information about all services belonging to the application specified by the application id.","operationId":"GetServiceInfoList","parameters":[{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/ServiceTypeNameOptionalQueryParam"},{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ContinuationTokenOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"List of services in the cluster for the specified application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedServiceInfoList"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the information about all services belonging to the application specified by the application id.","tags":["Service"]}},"/Applications/{applicationId}/$/GetServices/$/Create":{"post":{"description":"Creates the specified service.","operationId":"CreateService","parameters":[{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDescription"}}},"description":"The configuration for the service.","required":true,"x-ms-parameter-location":"method"},"responses":{"202":{"description":"A successful operation will return 202 status code."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Creates the specified service.","tags":["Service"]}},"/Applications/{applicationId}/$/GetServices/$/CreateFromTemplate":{"post":{"description":"Creates a Service Fabric service from the service template defined in the application manifest.","operationId":"CreateServiceFromTemplate","parameters":[{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceFromTemplateDescription"}}},"description":"Describes the service that needs to be created from the template defined in the application manifest.","required":true,"x-ms-parameter-location":"method"},"responses":{"202":{"description":"A successful operation will return 202 status code."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Creates a Service Fabric service from the service template defined in the application manifest.","tags":["Service"]}},"/Applications/{applicationId}/$/GetServices/{serviceId}":{"get":{"description":"Returns the information about specified service belonging to the specified Service Fabric application.","operationId":"GetServiceInfo","parameters":[{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/ServiceIdRequiredPathParam"},{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"Information about the specified service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceInfo"}}}},"204":{"description":"An empty response is returned if the specified service is not part of the specified application."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the information about the specific service belonging to a Service Fabric application.","tags":["Service"]}},"/Applications/{applicationId}/$/GetUpgradeProgress":{"get":{"description":"Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.","operationId":"GetApplicationUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"The application upgrade details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpgradeProgressInfo"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets details for the latest upgrade performed on this application.","tags":["Application"]}},"/Applications/{applicationId}/$/MoveToNextUpgradeDomain":{"post":{"description":"Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.","operationId":"ResumeApplicationUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumeApplicationUpgradeDescription"}}},"description":"Describes the parameters for resuming an application upgrade.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful response means that the application upgrade has been resumed in the specified upgrade domain. Use GetApplicationUpgrade operation to get the status of the upgrade."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Resumes upgrading an application in the Service Fabric cluster.","tags":["Application"]}},"/Applications/{applicationId}/$/ReportHealth":{"post":{"description":"Reports health state of the specified Service Fabric application. 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 Application, 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 GetApplicationHealth and check that the report appears in the HealthEvents section.\n","operationId":"ReportApplicationHealth","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"$ref":"#/components/requestBodies/HealthInformation"},"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":"Sends a health report on the Service Fabric application.","tags":["Application"]}},"/Applications/{applicationId}/$/RollbackUpgrade":{"post":{"description":"Starts rolling back the current application upgrade to the previous version. This API can only be used to rollback the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version including rolling back to a previous version.","operationId":"RollbackApplicationUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"A successful response means that the application has started to rollback. Use GetApplicationUpgrade operation to get the status of the upgrade."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.","tags":["Application"]}},"/Applications/{applicationId}/$/UpdateUpgrade":{"post":{"description":"Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.","operationId":"UpdateApplicationUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpgradeUpdateDescription"}}},"description":"Describes the parameters for updating an existing application upgrade.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful response means that the application upgrade has updated with the specified parameters. Use GetApplicationUpgrade operation to get the status of the upgrade."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Updates an ongoing application upgrade in the Service Fabric cluster.","tags":["Application"]}},"/Applications/{applicationId}/$/Upgrade":{"post":{"description":"Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid.","operationId":"StartApplicationUpgrade","parameters":[{"$ref":"#/components/parameters/ApiVersionRequiredQueryParam"},{"$ref":"#/components/parameters/ApplicationIdRequiredPathParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpgradeDescription"}}},"description":"Describes the parameters for an application upgrade.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"A successful response means that the application upgrade has started. Use GetApplicationUpgrade operation to get the status of the upgrade."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Starts upgrading an application in the Service Fabric cluster.","tags":["Application"]}},"/ComposeDeployments":{"get":{"description":"Gets the status about the compose applications that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status and other details about the compose application. If the applications do not 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.","operationId":"GetComposeApplicationStatusList","parameters":[{"$ref":"#/components/parameters/ApiVersion_4-0-Preview_RequiredQueryParam"},{"$ref":"#/components/parameters/ContinuationTokenOptionalQueryParam"},{"$ref":"#/components/parameters/MaxResultsOptionalQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"responses":{"200":{"description":"List of status of compose applications ins the cluster.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedComposeApplicationStatusInfoList"}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Gets the list of compose applications created in the Service Fabric cluster.","tags":["Compose Deployment"]}},"/ComposeDeployments/$/Create":{"put":{"description":"Creates a Service Fabric compose application.","operationId":"CreateComposeApplication","parameters":[{"$ref":"#/components/parameters/ApiVersion_4-0-Preview_RequiredQueryParam"},{"$ref":"#/components/parameters/TimeoutOptionalQueryParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateComposeApplicationDescription"}}},"description":"Describes the compose application that needs to be created.","required":true,"x-ms-parameter-location":"method"},"responses":{"202":{"description":"A successful operation will return 202 status code."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricError"}}}}},"summary":"Creates a Service Fabric compose application.","tags":["Compose Deployment"]}},"/ComposeDeployments/{applicationId}":{"get":{"description":"Returns the status of compose application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status and other details about the application.","operationId":"G