@lap v0.3 # Machine-readable API spec. Each @endpoint block is one API call. @api Service Fabric Client APIs @base http://localhost:19080 @version 6.5.0.36 @common_fields {api-version: any # The version of the API. This parameter is required and its value must be '6.0'. Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification. Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.} @endpoints 234 @hint download_for_search @toc $(35), Nodes(32), ApplicationTypes(8), Applications(23), Services(17), Partitions(25), ComposeDeployments(7), Tools(6), ImageStore(12), Faults(10), BackupRestore(7), Names(9), EventsStore(13), Resources(30) @group $ @endpoint GET /$/GetClusterManifest @desc Get the Service Fabric cluster manifest. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster manifest information. @endpoint GET /$/GetClusterHealth @desc Gets the health of a Service Fabric cluster. @optional {NodesHealthStateFilter: any # Allows filtering of the node health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ApplicationsHealthStateFilter: any # Allows filtering of the application health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value obtained from members or bitwise operations on members of HealthStateFilter enumeration. Only applications that match the filter are returned. All applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., IncludeSystemApplicationHealthStatistics: any # Indicates whether the health statistics should include the fabric:/System application health statistics. False by default. If IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application. Otherwise, the query result includes health statistics only for user applications. The health statistics must be included in the query result for this parameter to be applied., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster health information. @endpoint POST /$/GetClusterHealth @desc Gets the health of a Service Fabric cluster using the specified policy. @optional {NodesHealthStateFilter: any # Allows filtering of the node health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ApplicationsHealthStateFilter: any # Allows filtering of the application health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value obtained from members or bitwise operations on members of HealthStateFilter enumeration. Only applications that match the filter are returned. All applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., IncludeSystemApplicationHealthStatistics: any # Indicates whether the health statistics should include the fabric:/System application health statistics. False by default. If IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application. Otherwise, the query result includes health statistics only for user applications. The health statistics must be included in the query result for this parameter to be applied., ClusterHealthPolicies: any # Describes the health policies used to evaluate the cluster health. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy. By 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. If the application health policy map is specified, and it has an entry for an application, the specified application health policy is used to evaluate the application health., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster health information. @endpoint GET /$/GetClusterHealthChunk @desc Gets the health of a Service Fabric cluster using health chunks. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster health chunk information. @endpoint POST /$/GetClusterHealthChunk @desc Gets the health of a Service Fabric cluster using health chunks. @optional {ClusterHealthChunkQueryDescription: any # Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned. If 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. By 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. If the application health policy map is specified, and it has an entry for an application, the specified application health policy is used to evaluate the application health. Users 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. The query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return only services that are in Error or Warning, and all partitions and replicas for one of these services., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster health chunk information. @endpoint POST /$/ReportClusterHealth @desc Sends a health report on the Service Fabric cluster. @required {HealthInformation: any # Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.} @optional {Immediate: any # A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code when the cluster health report is accepted for processing. @endpoint GET /$/GetProvisionedCodeVersions @desc Gets a list of fabric code versions that are provisioned in a Service Fabric cluster. @optional {CodeVersion: any # The product version of Service Fabric., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested provisioned code versions information. @endpoint GET /$/GetProvisionedConfigVersions @desc Gets a list of fabric config versions that are provisioned in a Service Fabric cluster. @optional {ConfigVersion: any # The config version of Service Fabric., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested provisioned config versions information. @endpoint GET /$/GetUpgradeProgress @desc Gets the progress of the current cluster upgrade. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster upgrade progress. @endpoint GET /$/GetClusterConfiguration @desc Get the Service Fabric standalone cluster configuration. @required {ConfigurationApiVersion: any # The API version of the Standalone cluster json configuration.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster configuration information. @endpoint GET /$/GetClusterConfigurationUpgradeStatus @desc Get the cluster configuration upgrade status of a Service Fabric standalone cluster. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster configuration upgrade status. @endpoint GET /$/GetUpgradeOrchestrationServiceState @desc Get the service state of Service Fabric Upgrade Orchestration Service. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested service state of Service Fabric Upgrade Orchestration Service. @endpoint POST /$/SetUpgradeOrchestrationServiceState @desc Update the service state of Service Fabric Upgrade Orchestration Service. @required {UpgradeOrchestrationServiceState: any # Service state of Service Fabric Upgrade Orchestration Service.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the service state of Service Fabric Upgrade Orchestration Service has been updated. @endpoint POST /$/Provision @desc Provision the code or configuration packages of a Service Fabric cluster. @required {ProvisionFabricDescription: any # Describes the parameters for provisioning a cluster.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the code or configuration packages have been provisioned. @endpoint POST /$/Unprovision @desc Unprovision the code or configuration packages of a Service Fabric cluster. @required {UnprovisionFabricDescription: any # Describes the parameters for unprovisioning a cluster.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the code or configuration packages have been unprovisioned. @endpoint POST /$/RollbackUpgrade @desc Roll back the upgrade of a Service Fabric cluster. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A successful response means that the rollback of a cluster upgrade has been initiated. @endpoint POST /$/MoveToNextUpgradeDomain @desc Make the cluster upgrade move on to the next upgrade domain. @required {ResumeClusterUpgradeDescription: any # Describes the parameters for resuming a cluster upgrade.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the cluster upgrade has moved on to the next upgrade domain. @endpoint POST /$/Upgrade @desc Start upgrading the code or configuration version of a Service Fabric cluster. @required {StartClusterUpgradeDescription: any # Describes the parameters for starting a cluster upgrade.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A successful response means that the cluster code or configuration upgrade has started. Use GetUpgradeProgress operation to get the status of the upgrade. @endpoint POST /$/StartClusterConfigurationUpgrade @desc Start upgrading the configuration of a Service Fabric standalone cluster. @required {ClusterConfigurationUpgradeDescription: any # Parameters for a standalone cluster configuration upgrade.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade. @endpoint POST /$/UpdateUpgrade @desc Update the upgrade parameters of a Service Fabric cluster upgrade. @required {UpdateClusterUpgradeDescription: any # Parameters for updating a cluster upgrade.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation returns 200 status code. @endpoint GET /$/GetAadMetadata @desc Gets the Azure Active Directory metadata used for secured connection to cluster. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the Azure Active Directory metadata. @endpoint GET /$/GetClusterVersion @desc Get the current Service Fabric cluster version. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster version information. @endpoint GET /$/GetLoadInformation @desc Gets the load of a Service Fabric cluster. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested cluster load information. @endpoint POST /$/ToggleVerboseServicePlacementHealthReporting @desc Changes the verbosity of service placement health reporting. @required {Enabled: any # The verbosity of service placement health reporting.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the verbosity of service placement health reporting was updated. @endgroup @group Nodes @endpoint GET /Nodes @desc Gets the list of nodes in the Service Fabric cluster. @optional {ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., NodeStatusFilter: any # Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of nodes in the cluster. @endpoint GET /Nodes/{nodeName} @desc Gets the information about a specific node in the Service Fabric cluster. @required {nodeName: any # The name of the node.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return information about the node with the specified nodeName. @returns(204) An empty response is returned if the specified nodeName is not found. @endpoint GET /Nodes/{nodeName}/$/GetHealth @desc Gets the health of a Service Fabric node. @required {nodeName: any # The name of the node.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested node health information. @endpoint POST /Nodes/{nodeName}/$/GetHealth @desc Gets the health of a Service Fabric node, by using the specified health policy. @required {nodeName: any # The name of the node.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ClusterHealthPolicy: any # Describes the health policies used to evaluate the health of a cluster or node. If not present, the health evaluation uses the health policy from cluster manifest or the default health policy., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested node health information. @endpoint POST /Nodes/{nodeName}/$/ReportHealth @desc Sends a health report on the Service Fabric node. @required {nodeName: any # The name of the node., HealthInformation: any # Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.} @optional {Immediate: any # A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /Nodes/{nodeName}/$/GetLoadInformation @desc Gets the load information of a Service Fabric node. @required {nodeName: any # The name of the node.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested node load information. @endpoint POST /Nodes/{nodeName}/$/Deactivate @desc Deactivate a Service Fabric cluster node with the specified deactivation intent. @required {nodeName: any # The name of the node., DeactivationIntentDescription: any # Describes the intent or reason for deactivating the node.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint POST /Nodes/{nodeName}/$/Activate @desc Activate a Service Fabric cluster node that is currently deactivated. @required {nodeName: any # The name of the node.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint POST /Nodes/{nodeName}/$/RemoveNodeState @desc Notifies Service Fabric that the persisted state on a node has been permanently removed or lost. @required {nodeName: any # The name of the node.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint POST /Nodes/{nodeName}/$/Restart @desc Restarts a Service Fabric cluster node. @required {nodeName: any # The name of the node., RestartNodeDescription: any # The instance of the node to be restarted and a flag indicating the need to take dump of the fabric process.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. A successful operation means that the restart command was received by the node and it is in the process of restarting. Check the status of the node by calling GetNode operation. @endgroup @group ApplicationTypes @endpoint GET /ApplicationTypes @desc Gets the list of application types in the Service Fabric cluster. @optional {ApplicationTypeDefinitionKindFilter: any # Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type. - Default - Default value, which performs the same function as selecting "All". The value is 0. - All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535. - ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1. - Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2., ExcludeApplicationParameters: any # The flag that specifies whether application parameters will be excluded from the result., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of application types in the cluster. @endpoint GET /ApplicationTypes/{applicationTypeName} @desc Gets the list of application types in the Service Fabric cluster matching exactly the specified name. @required {applicationTypeName: any # The name of the application type.} @optional {ApplicationTypeVersion: any # The version of the application type., ExcludeApplicationParameters: any # The flag that specifies whether application parameters will be excluded from the result., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of application types in the cluster. @endpoint POST /ApplicationTypes/$/Provision @desc 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. @required {ProvisionApplicationTypeDescriptionBaseRequiredBodyParam: any # The base type of provision application type description which supports either image store-based provision or external store-based provision.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful provision will return 200 status code. @returns(202) A 202 status code indicates the operation was accepted and the provision operation has been initiated. @endpoint POST /ApplicationTypes/{applicationTypeName}/$/Unprovision @desc Removes or unregisters a Service Fabric application type from the cluster. @required {applicationTypeName: any # The name of the application type., UnprovisionApplicationTypeDescriptionInfo: any # The relative path for the application package in the image store specified during the prior copy operation.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful provision will return 200 status code. @returns(202) A 202 status code indicates the operation was accepted. @endpoint GET /ApplicationTypes/{applicationTypeName}/$/GetServiceTypes @desc Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. @required {applicationTypeName: any # The name of the application type., ApplicationTypeVersion: any # The version of the application type.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of service types that are supported by a provisioned application type. @endpoint GET /ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName} @desc Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. @required {applicationTypeName: any # The name of the application type., ApplicationTypeVersion: any # The version of the application type., serviceTypeName: any # Specifies the name of a Service Fabric service type.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A specific service type which supported by a provisioned application type. @returns(204) A 204 response is returned if the specified service type is not found in the cluster. @endpoint GET /ApplicationTypes/{applicationTypeName}/$/GetServiceManifest @desc Gets the manifest describing a service type. @required {applicationTypeName: any # The name of the application type., ApplicationTypeVersion: any # The version of the application type., ServiceManifestName: any # The name of a service manifest registered as part of an application type in a Service Fabric cluster.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the service type. @endgroup @group Nodes @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes @desc Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {ServiceManifestName: any # The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of information about service types of an application deployed on a node. @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName} @desc Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., serviceTypeName: any # Specifies the name of a Service Fabric service type.} @optional {ServiceManifestName: any # The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about service types of an application deployed on a node. @returns(204) An empty response is returned if the specified service type of the application is not deployed on the node. @endgroup @group Applications @endpoint POST /Applications/$/Create @desc Creates a Service Fabric application. @required {ApplicationDescription: any # Description for creating an application.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(201) 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. @endpoint POST /Applications/{applicationId}/$/Delete @desc Deletes an existing Service Fabric application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {ForceRemove: any # Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /Applications/{applicationId}/$/GetLoadInformation @desc Gets load information about a Service Fabric application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the application load. @returns(204) An empty response is returned if the specified applicationId is not found in the cluster. @endpoint GET /Applications @desc Gets the list of applications created in the Service Fabric cluster that match the specified filters. @optional {ApplicationDefinitionKindFilter: any # Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application. - Default - Default value, which performs the same function as selecting "All". The value is 0. - All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535. - ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1. - Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2., ApplicationTypeName: any # The application type name used to filter the applications to query for. This value should not contain the application type version., ExcludeApplicationParameters: any # The flag that specifies whether application parameters will be excluded from the result., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of applications created in the cluster. @endpoint GET /Applications/{applicationId} @desc Gets information about a Service Fabric application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {ExcludeApplicationParameters: any # The flag that specifies whether application parameters will be excluded from the result., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the application. @returns(204) An empty response is returned if the specified applicationId is not found in the cluster. @endpoint GET /Applications/{applicationId}/$/GetHealth @desc Gets the health of the service fabric application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., DeployedApplicationsHealthStateFilter: any # Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned. All deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ServicesHealthStateFilter: any # Allows filtering of the services health state objects returned in the result of services health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested application health information. @endpoint POST /Applications/{applicationId}/$/GetHealth @desc Gets the health of a Service Fabric application using the specified policy. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., DeployedApplicationsHealthStateFilter: any # Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned. All deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ServicesHealthStateFilter: any # Allows filtering of the services health state objects returned in the result of services health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., ApplicationHealthPolicy: any # Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested node health information. @endpoint POST /Applications/{applicationId}/$/ReportHealth @desc Sends a health report on the Service Fabric application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., HealthInformation: any # Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.} @optional {Immediate: any # A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint POST /Applications/{applicationId}/$/Upgrade @desc Starts upgrading an application in the Service Fabric cluster. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., ApplicationUpgradeDescription: any # Parameters for an application upgrade.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the application upgrade has started. Use GetApplicationUpgrade operation to get the status of the upgrade. @endpoint GET /Applications/{applicationId}/$/GetUpgradeProgress @desc Gets details for the latest upgrade performed on this application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) The application upgrade details. @endpoint POST /Applications/{applicationId}/$/UpdateUpgrade @desc Updates an ongoing application upgrade in the Service Fabric cluster. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., ApplicationUpgradeUpdateDescription: any # Parameters for updating an existing application upgrade.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the application upgrade has updated with the specified parameters. Use GetApplicationUpgrade operation to get the status of the upgrade. @endpoint POST /Applications/{applicationId}/$/MoveToNextUpgradeDomain @desc Resumes upgrading an application in the Service Fabric cluster. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., ResumeApplicationUpgradeDescription: any # Describes the parameters for resuming an application upgrade.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) 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. @endpoint POST /Applications/{applicationId}/$/RollbackUpgrade @desc Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the application has started to roll back. Use GetApplicationUpgrade operation to get the status of the upgrade. @endgroup @group Nodes @endpoint GET /Nodes/{nodeName}/$/GetApplications @desc Gets the list of applications deployed on a Service Fabric node. @required {nodeName: any # The name of the node.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., IncludeHealthState: any # Include the health state of an entity. If this parameter is false or not specified, then the health state returned is "Unknown". When set to true, the query goes in parallel to the node and the health system service before the results are merged. As a result, the query is more expensive and may take a longer time., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.} @returns(200) A successful operation will return 200 status code and the list of deployed application information. @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId} @desc Gets the information about an application deployed on a Service Fabric node. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., IncludeHealthState: any # Include the health state of an entity. If this parameter is false or not specified, then the health state returned is "Unknown". When set to true, the query goes in parallel to the node and the health system service before the results are merged. As a result, the query is more expensive and may take a longer time.} @returns(200) A successful operation will return 200 status code and the information about the deployed application. @returns(204) An empty response is returned if the specified application is not deployed on the node. @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth @desc Gets the information about health of an application deployed on a Service Fabric node. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., DeployedServicePackagesHealthStateFilter: any # Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application. If not specified, all entries are returned. The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator. For example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the health information of the deployed application. @endpoint POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth @desc Gets the information about health of an application deployed on a Service Fabric node. using the specified policy. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., DeployedServicePackagesHealthStateFilter: any # Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application. If not specified, all entries are returned. The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator. For example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ApplicationHealthPolicy: any # Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the health information of the deployed application. @endpoint POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth @desc Sends a health report on the Service Fabric application deployed on a Service Fabric node. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., HealthInformation: any # Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.} @optional {Immediate: any # A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endgroup @group ApplicationTypes @endpoint GET /ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest @desc Gets the manifest describing an application type. @required {applicationTypeName: any # The name of the application type., ApplicationTypeVersion: any # The version of the application type.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the node. @endgroup @group Applications @endpoint GET /Applications/{applicationId}/$/GetServices @desc Gets the information about all services belonging to the application specified by the application ID. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {ServiceTypeName: any # The service type name used to filter the services to query for., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of services in the cluster for the specified application. @endpoint GET /Applications/{applicationId}/$/GetServices/{serviceId} @desc Gets the information about the specific service belonging to the Service Fabric application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the specified service. @returns(204) An empty response is returned if the specified service is not part of the specified application. @endgroup @group Services @endpoint GET /Services/{serviceId}/$/GetApplicationName @desc Gets the name of the Service Fabric application for a service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the name of the application for the specified service. @endgroup @group Applications @endpoint POST /Applications/{applicationId}/$/GetServices/$/Create @desc Creates the specified Service Fabric service. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., ServiceDescription: any # The information necessary to create a service.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A successful operation will return 202 status code. @endpoint POST /Applications/{applicationId}/$/GetServices/$/CreateFromTemplate @desc Creates a Service Fabric service from the service template. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., ServiceFromTemplateDescription: any # Describes the service that needs to be created from the template defined in the application manifest.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A successful operation will return 202 status code. @endgroup @group Services @endpoint POST /Services/{serviceId}/$/Delete @desc Deletes an existing Service Fabric service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {ForceRemove: any # Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint POST /Services/{serviceId}/$/Update @desc Updates a Service Fabric service using the specified update description. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., ServiceUpdateDescription: any # The information necessary to update a service.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 202 status code. @endpoint GET /Services/{serviceId}/$/GetDescription @desc Gets the description of an existing Service Fabric service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /Services/{serviceId}/$/GetHealth @desc Gets the health of the specified Service Fabric service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., PartitionsHealthStateFilter: any # Allows filtering of the partitions health state objects returned in the result of service health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the health information of the specified service. @endpoint POST /Services/{serviceId}/$/GetHealth @desc Gets the health of the specified Service Fabric service, by using the specified health policy. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., PartitionsHealthStateFilter: any # Allows filtering of the partitions health state objects returned in the result of service health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ApplicationHealthPolicy: any # Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the health information of the specified service. @endpoint POST /Services/{serviceId}/$/ReportHealth @desc Sends a health report on the Service Fabric service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., HealthInformation: any # Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.} @optional {Immediate: any # A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /Services/{serviceId}/$/ResolvePartition @desc Resolve a Service Fabric partition. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {PartitionKeyType: any # Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following. - None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1. - Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2. - Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3., PartitionKeyValue: any # Partition key. This is required if the partition scheme for the service is Int64Range or Named. This is not the partition ID, but rather, either the integer key value, or the name of the partition ID. For example, if your service is using ranged partitions from 0 to 10, then they PartitionKeyValue would be an integer in that range. Query service description to see the range or name., PreviousRspVersion: any # The value in the Version field of the response that was received previously. This is required if the user knows that the result that was gotten previously is stale., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /Services/{serviceId}/$/GetUnplacedReplicaInformation @desc Gets the information about unplaced replica of the service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {PartitionId: any # The identity of the partition., OnlyQueryPrimaries: any # Indicates that unplaced replica information will be queries only for primary replicas., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the specified service. @endpoint GET /Services/{serviceId}/$/GetPartitions @desc Gets the list of partitions of a Service Fabric service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of partitions of a Service Fabric service. @endgroup @group Partitions @endpoint GET /Partitions/{partitionId} @desc Gets the information about a Service Fabric partition. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the specified partition. @returns(204) An empty response is returned if the specified partitionId is not found in the cluster. @endpoint GET /Partitions/{partitionId}/$/GetServiceName @desc Gets the name of the Service Fabric service for a partition. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the name of the service for the specified partition. @endpoint GET /Partitions/{partitionId}/$/GetHealth @desc Gets the health of the specified Service Fabric partition. @required {partitionId: any # The identity of the partition.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ReplicasHealthStateFilter: any # Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the health information about the specified partition. @endpoint POST /Partitions/{partitionId}/$/GetHealth @desc Gets the health of the specified Service Fabric partition, by using the specified health policy. @required {partitionId: any # The identity of the partition.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ReplicasHealthStateFilter: any # Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ApplicationHealthPolicy: any # Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy., ExcludeHealthStatistics: any # Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the health information about the specified partition. @endpoint POST /Partitions/{partitionId}/$/ReportHealth @desc Sends a health report on the Service Fabric partition. @required {partitionId: any # The identity of the partition., HealthInformation: any # Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.} @optional {Immediate: any # A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /Partitions/{partitionId}/$/GetLoadInformation @desc Gets the load information of the specified Service Fabric partition. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the specified partition's last reported load metrics. @endpoint POST /Partitions/{partitionId}/$/ResetLoad @desc Resets the current load of a Service Fabric partition. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation request will return 200 status code. @endpoint POST /Partitions/{partitionId}/$/Recover @desc Indicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation request will return 200 status code. @endgroup @group Services @endpoint POST /Services/$/{serviceId}/$/GetPartitions/$/Recover @desc Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation request will return 200 status code. @endgroup @group $ @endpoint POST /$/RecoverSystemPartitions @desc Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation request will return 200 status code. @endpoint POST /$/RecoverAllPartitions @desc Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation request will return 200 status code. @endgroup @group Partitions @endpoint POST /Partitions/{partitionId}/$/MovePrimaryReplica @desc Moves the primary replica of a partition of a stateful service. @required {partitionId: any # The identity of the partition.} @optional {NodeName: any # The name of the node., IgnoreConstraints: any # Ignore constraints when moving a replica. If this parameter is not specified, all constraints are honored., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation request will return 200 status code. @endpoint POST /Partitions/{partitionId}/$/MoveSecondaryReplica @desc Moves the secondary replica of a partition of a stateful service. @required {partitionId: any # The identity of the partition., CurrentNodeName: any # The name of the source node for secondary replica move.} @optional {NewNodeName: any # The name of the target node for secondary replica move. If not specified, replica is moved to a random node., IgnoreConstraints: any # Ignore constraints when moving a replica. If this parameter is not specified, all constraints are honored., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation request will return 200 status code. @endgroup @group $ @endpoint POST /$/CreateRepairTask @desc Creates a new repair task. @required {RepairTask: any # Describes the repair task to be created or updated.} @returns(200) A successful operation will return 200 status code. The response body provides information about the created repair task. @endpoint POST /$/CancelRepairTask @desc Requests the cancellation of the given repair task. @required {RepairTaskCancelDescription: any # Describes the repair task to be cancelled.} @returns(200) A successful operation will return 200 status code. The response body provides information about the updated repair task. Success indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled. Clients may use the State property of the repair task to determine the current state of the repair task. @endpoint POST /$/DeleteRepairTask @desc Deletes a completed repair task. @required {RepairTaskDeleteDescription: any # Describes the repair task to be deleted.} @returns(200) A successful operation will return 200 status code. @endpoint GET /$/GetRepairTaskList @desc Gets a list of repair tasks matching the given filters. @optional {TaskIdFilter: any # The repair task ID prefix to be matched., StateFilter: any # A bitwise-OR of the following values, specifying which task states should be included in the result list. - 1 - Created - 2 - Claimed - 4 - Preparing - 8 - Approved - 16 - Executing - 32 - Restoring - 64 - Completed, ExecutorFilter: any # The name of the repair executor whose claimed tasks should be included in the list.} @returns(200) A successful operation will return 200 status code. The response body provides a list of repair tasks matching all of the given filters. @endpoint POST /$/ForceApproveRepairTask @desc Forces the approval of the given repair task. @required {RepairTaskApproveDescription: any # Describes the repair task to be approved.} @returns(200) A successful operation will return 200 status code. The response body provides information about the updated repair task. @endpoint POST /$/UpdateRepairTaskHealthPolicy @desc Updates the health policy of the given repair task. @required {RepairTaskUpdateHealthPolicyDescription: any # Describes the repair task healthy policy to be updated.} @returns(200) A successful operation will return 200 status code. The response body provides information about the updated repair task. @endpoint POST /$/UpdateRepairExecutionState @desc Updates the execution state of a repair task. @required {RepairTask: any # Describes the repair task to be created or updated.} @returns(200) A successful operation will return 200 status code. The response body provides information about the updated repair task. @endgroup @group Partitions @endpoint GET /Partitions/{partitionId}/$/GetReplicas @desc Gets the information about replicas of a Service Fabric service partition. @required {partitionId: any # The identity of the partition.} @optional {ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the replicas of the specified partition. @endpoint GET /Partitions/{partitionId}/$/GetReplicas/{replicaId} @desc Gets the information about a replica of a Service Fabric partition. @required {partitionId: any # The identity of the partition., replicaId: any # The identifier of the replica.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the specified replicas of the specified partition of a Service Fabric service. @returns(204) An empty response is returned if the specified replicaId is not a replica of the specified partition. @endpoint GET /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth @desc Gets the health of a Service Fabric stateful service replica or stateless service instance. @required {partitionId: any # The identity of the partition., replicaId: any # The identifier of the replica.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested replica health. @endpoint POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth @desc Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy. @required {partitionId: any # The identity of the partition., replicaId: any # The identifier of the replica.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ApplicationHealthPolicy: any # Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested replica health information. @endpoint POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth @desc Sends a health report on the Service Fabric replica. @required {partitionId: any # The identity of the partition., replicaId: any # The identifier of the replica., ServiceKind: any # The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values., HealthInformation: any # Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.} @optional {Immediate: any # A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endgroup @group Nodes @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas @desc Gets the list of replicas deployed on a Service Fabric node. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {PartitionId: any # The identity of the partition., ServiceManifestName: any # The name of a service manifest registered as part of an application type in a Service Fabric cluster., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the list of deployed service replica information. @returns(204) An empty response is returned if the specified applicationId is not found on the specified node. An empty response is also returned if there are no replicas matching the specified filter values for PartitionId or ServiceManifestName query parameters. @endpoint GET /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail @desc Gets the details of replica deployed on a Service Fabric node. @required {nodeName: any # The name of the node., partitionId: any # The identity of the partition., replicaId: any # The identifier of the replica.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the list of deployed service replica information. @endpoint GET /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas @desc Gets the details of replica deployed on a Service Fabric node. @required {nodeName: any # The name of the node., partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the list of deployed service replica information. @endpoint POST /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart @desc Restarts a service replica of a persisted service running on a node. @required {nodeName: any # The name of the node., partitionId: any # The identity of the partition., replicaId: any # The identifier of the replica.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting. @endpoint POST /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete @desc Removes a service replica running on a node. @required {nodeName: any # The name of the node., partitionId: any # The identity of the partition., replicaId: any # The identifier of the replica.} @optional {ForceRemove: any # Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting. @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages @desc Gets the list of service packages deployed on a Service Fabric node. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the list of deployed service packages information. @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName} @desc Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., servicePackageName: any # The name of the service package.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the list of deployed service packages information. @returns(204) An empty response is returned if the specified service package from the application is not deployed on the node. @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth @desc Gets the information about health of a service package for a specific application deployed for a Service Fabric node and application. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., servicePackageName: any # The name of the service package.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application. @endpoint POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth @desc Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., servicePackageName: any # The name of the service package.} @optional {EventsHealthStateFilter: any # Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535., ApplicationHealthPolicy: any # Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application. @endpoint POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth @desc Sends a health report on the Service Fabric deployed service package. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., servicePackageName: any # The name of the service package., HealthInformation: any # Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.} @optional {Immediate: any # A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint POST /Nodes/{nodeName}/$/DeployServicePackage @desc Downloads all of the code packages associated with specified service manifest on the specified node. @required {nodeName: any # The name of the node., DeployServicePackageToNodeDescription: any # Describes information for deploying a service package to a Service Fabric node.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages @desc Gets the list of code packages deployed on a Service Fabric node. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {ServiceManifestName: any # The name of a service manifest registered as part of an application type in a Service Fabric cluster., CodePackageName: any # The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the list of deployed code packages information. @endpoint POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart @desc Restarts a code package deployed on a Service Fabric node in a cluster. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., RestartDeployedCodePackageDescription: any # Describes the deployed code package on Service Fabric node to restart.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs @desc Gets the container logs for container deployed on a Service Fabric node. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., ServiceManifestName: any # The name of a service manifest registered as part of an application type in a Service Fabric cluster., CodePackageName: any # The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster.} @optional {Tail: any # Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs., Previous: any # Specifies whether to get container logs from exited/dead containers of the code package instance., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the container logs for container deployed on a Service Fabric node for the given code package. @endpoint POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi @desc Invoke container API on a container deployed on a Service Fabric node. @required {nodeName: any # The name of the node., applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., ServiceManifestName: any # The name of a service manifest registered as part of an application type in a Service Fabric cluster., CodePackageName: any # The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster., CodePackageInstanceId: any # ID that uniquely identifies a code package instance deployed on a service fabric node., ContainerApiRequestBody: any # Parameters for making container API call} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and container API response for a container deployed on a Service Fabric node for the given code package. @endgroup @group ComposeDeployments @endpoint PUT /ComposeDeployments/$/Create @desc Creates a Service Fabric compose deployment. @required {CreateComposeDeploymentDescription: any # Describes the compose deployment that needs to be created.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A successful operation will return 202 status code. @endpoint GET /ComposeDeployments/{deploymentName} @desc Gets information about a Service Fabric compose deployment. @required {deploymentName: any # The identity of the deployment.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the compose deployment. @endpoint GET /ComposeDeployments @desc Gets the list of compose deployments created in the Service Fabric cluster. @optional {ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of status of compose deployments in the cluster. @endpoint GET /ComposeDeployments/{deploymentName}/$/GetUpgradeProgress @desc Gets details for the latest upgrade performed on this Service Fabric compose deployment. @required {deploymentName: any # The identity of the deployment.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Details about the compose deployment upgrade. @endpoint POST /ComposeDeployments/{deploymentName}/$/Delete @desc Deletes an existing Service Fabric compose deployment from cluster. @required {deploymentName: any # The identity of the deployment.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A successful operation will return 202 status code. @endpoint POST /ComposeDeployments/{deploymentName}/$/Upgrade @desc Starts upgrading a compose deployment in the Service Fabric cluster. @required {deploymentName: any # The identity of the deployment., ComposeDeploymentUpgradeDescription: any # Parameters for upgrading compose deployment.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade. @endpoint POST /ComposeDeployments/{deploymentName}/$/RollbackUpgrade @desc Starts rolling back a compose deployment upgrade in the Service Fabric cluster. @required {deploymentName: any # The identity of the deployment.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the rollback has started. Use GetComposeDeploymentUpgrade operation to get the status of the rollback. @endgroup @group Tools @endpoint GET /Tools/Chaos @desc Get the status of Chaos. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the status of Chaos. @endpoint POST /Tools/Chaos/$/Start @desc Starts Chaos in the cluster. @required {ChaosParameters: any # Describes all the parameters to configure a Chaos run.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint POST /Tools/Chaos/$/Stop @desc Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /Tools/Chaos/Events @desc Gets the next segment of the Chaos events based on the continuation token or the time range. @optional {ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., StartTimeUtc: any # The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details., EndTimeUtc: any # The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Next segment of Chaos events. @endpoint GET /Tools/Chaos/Schedule @desc Get the Chaos Schedule defining when and how to run Chaos. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the schedule description including a Chaos Schedule used by Chaos and the version the Chaos Schedule is on. @endpoint POST /Tools/Chaos/Schedule @desc Set the schedule used by Chaos. @required {ChaosSchedule: any # Describes the schedule used by Chaos.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endgroup @group ImageStore @endpoint PUT /ImageStore/{contentPath} @desc Uploads contents of the file to the image store. @required {contentPath: any # Relative path to file or folder in the image store from its root.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) If the upload request succeeds, the server returns the HTTP 200 OK status code. @endpoint GET /ImageStore/{contentPath} @desc Gets the image store content information. @required {contentPath: any # Relative path to file or folder in the image store from its root.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested image store content information. @endpoint DELETE /ImageStore/{contentPath} @desc Deletes existing image store content. @required {contentPath: any # Relative path to file or folder in the image store from its root.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint GET /ImageStore @desc Gets the content information at the root of the image store. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested image store content information. @endpoint POST /ImageStore/$/Copy @desc Copies image store content internally @required {ImageStoreCopyDescription: any # Describes the copy description for the image store.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint DELETE /ImageStore/$/DeleteUploadSession @desc Cancels an image store upload session. @required {session-id: any # A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint POST /ImageStore/$/CommitUploadSession @desc Commit an image store upload session. @required {session-id: any # A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) If the commit request succeeds, the server returns the HTTP 200 OK status code. @endpoint GET /ImageStore/$/GetUploadSession @desc Get the image store upload session by ID. @required {session-id: any # A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested image store upload session information. @endpoint GET /ImageStore/{contentPath}/$/GetUploadSession @desc Get the image store upload session by relative path. @required {contentPath: any # Relative path to file or folder in the image store from its root.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested image store upload session information. @endpoint PUT /ImageStore/{contentPath}/$/UploadChunk @desc Uploads a file chunk to the image store relative path. @required {contentPath: any # Relative path to file or folder in the image store from its root., session-id: any # A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed., Content-Range: any # When uploading file chunks to the image store, the Content-Range header field need to be configured and sent with a request. The format should looks like "bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}". For example, Content-Range:bytes 300-5000/20000 indicates that user is sending bytes 300 through 5,000 and the total file length is 20,000 bytes.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return the HTTP 200 OK status code. @endpoint GET /ImageStore/$/FolderSize @desc Get the folder size at the root of the image store. @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested folder size in image store. @endpoint GET /ImageStore/{contentPath}/$/FolderSize @desc Get the size of a folder in image store @required {contentPath: any # Relative path to file or folder in the image store from its root.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the requested folder size in image store. @endgroup @group $ @endpoint POST /$/InvokeInfrastructureCommand @desc Invokes an administrative command on the given Infrastructure Service instance. @required {Command: any # The text of the command to be invoked. The content of the command is infrastructure-specific.} @optional {ServiceId: any # The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) The response from the infrastructure service. The response format is a JSON stream. The contents of the response depend on which command was issued. @endpoint GET /$/InvokeInfrastructureQuery @desc Invokes a read-only query on the given infrastructure service instance. @required {Command: any # The text of the command to be invoked. The content of the command is infrastructure-specific.} @optional {ServiceId: any # The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) The response from the infrastructure service. The response format is a JSON stream. The contents of the response depend on which command was issued. @endgroup @group Faults @endpoint POST /Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLoss @desc This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., partitionId: any # The identity of the partition., OperationId: any # A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API, DataLossMode: any # This enum is passed to the StartDataLoss API to indicate what type of data loss to induce.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation was accepted. Call the GetDataLossProgress API to get the progress. @endpoint GET /Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress @desc Gets the progress of a partition data loss operation started using the StartDataLoss API. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., partitionId: any # The identity of the partition., OperationId: any # A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the progress of the partition data loss operation. @endpoint POST /Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLoss @desc Induces quorum loss for a given stateful service partition. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., partitionId: any # The identity of the partition., OperationId: any # A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API, QuorumLossMode: any # This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce., QuorumLossDuration: any # The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation was accepted. Call the GetQuorumLossProgress API to get the progress. @endpoint GET /Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgress @desc Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., partitionId: any # The identity of the partition., OperationId: any # A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the progress of a partition quorum loss operation. @endpoint POST /Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart @desc This API will restart some or all replicas or instances of the specified partition. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., partitionId: any # The identity of the partition., OperationId: any # A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API, RestartPartitionMode: any # Describe which partitions to restart.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation was accepted. Call the GetPartitionRestartProgress API to get the progress. @endpoint GET /Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgress @desc Gets the progress of a PartitionRestart operation started using StartPartitionRestart. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., partitionId: any # The identity of the partition., OperationId: any # A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the progress of a partition restart operation. @endpoint POST /Faults/Nodes/{nodeName}/$/StartTransition/ @desc Starts or stops a cluster node. @required {nodeName: any # The name of the node., OperationId: any # A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API, NodeTransitionType: any # Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up., NodeInstanceId: any # The node instance ID of the target node. This can be determined through GetNodeInfo API., StopDurationInSeconds: any # The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation was accepted. Call the GetNodeTransitionProgress API to get the progress. @endpoint GET /Faults/Nodes/{nodeName}/$/GetTransitionProgress @desc Gets the progress of an operation started using StartNodeTransition. @required {nodeName: any # The name of the node., OperationId: any # A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Information about the progress of a node transition operation. @endpoint GET /Faults/ @desc Gets a list of user-induced fault operations filtered by provided input. @required {TypeFilter: any # Used to filter on OperationType for user-induced operations. - 65535 - select all - 1 - select PartitionDataLoss. - 2 - select PartitionQuorumLoss. - 4 - select PartitionRestart. - 8 - select NodeTransition., StateFilter: any # Used to filter on OperationState's for user-induced operations. - 65535 - select All - 1 - select Running - 2 - select RollingBack - 8 - select Completed - 16 - select Faulted - 32 - select Cancelled - 64 - select ForceCancelled} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endpoint POST /Faults/$/Cancel @desc Cancels a user-induced fault operation. @required {OperationId: any # A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API, Force: any # Indicates whether to gracefully roll back and clean up internal system state modified by executing the user-induced operation.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code. @endgroup @group BackupRestore @endpoint POST /BackupRestore/BackupPolicies/$/Create @desc Creates a backup policy. @required {BackupPolicyDescription: any # Describes the backup policy.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(201) A successful operation returns 201 status code and creates a new backup policy. @endpoint POST /BackupRestore/BackupPolicies/{backupPolicyName}/$/Delete @desc Deletes the backup policy. @required {backupPolicyName: any # The name of the backup policy.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation returns 200 status code and deletes the backup policy. @endpoint GET /BackupRestore/BackupPolicies @desc Gets all the backup policies configured. @optional {ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and paged list of backup policies. @endpoint GET /BackupRestore/BackupPolicies/{backupPolicyName} @desc Gets a particular backup policy by name. @required {backupPolicyName: any # The name of the backup policy.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and the backup policy description. @endpoint GET /BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities @desc Gets the list of backup entities that are associated with this policy. @required {backupPolicyName: any # The name of the backup policy.} @optional {ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and a paged list of Service Fabric entities that are associated with this policy. @endpoint POST /BackupRestore/BackupPolicies/{backupPolicyName}/$/Update @desc Updates the backup policy. @required {BackupPolicyDescription: any # Describes the backup policy., backupPolicyName: any # The name of the backup policy.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation returns 200 status code and updates the backup policy description. @endgroup @group Applications @endpoint POST /Applications/{applicationId}/$/EnableBackup @desc Enables periodic backup of stateful partitions under this Service Fabric application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., EnableBackupDescription: any # Specifies the parameters for enabling backup.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the request to enable application backup has been accepted. @endpoint POST /Applications/{applicationId}/$/DisableBackup @desc Disables periodic backup of Service Fabric application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., DisableBackupDescription: any # Specifies the parameters to disable backup for any backup entity.} @returns(202) A 202 status code indicates the request to disable application backup has been accepted. @endpoint GET /Applications/{applicationId}/$/GetBackupConfigurationInfo @desc Gets the Service Fabric application backup configuration information. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and a paged list of backup configuration information for the application, and the services and partitions under this application, for which backup configuration has been overridden. @endpoint GET /Applications/{applicationId}/$/GetBackups @desc Gets the list of backups available for every partition in this application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., Latest: any # Specifies whether to get only the most recent backup available for a partition for the specified time range., StartDateTimeFilter: any # Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated., EndDateTimeFilter: any # Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.} @returns(200) A successful operation will return 200 status code and a paged list of backup information. @endpoint POST /Applications/{applicationId}/$/SuspendBackup @desc Suspends periodic backup for the specified Service Fabric application. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation request was accepted and application backup will be suspended. @endpoint POST /Applications/{applicationId}/$/ResumeBackup @desc Resumes periodic backup of a Service Fabric application which was previously suspended. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation request was accepted and application backup will be resumed. @endgroup @group Services @endpoint POST /Services/{serviceId}/$/EnableBackup @desc Enables periodic backup of stateful partitions under this Service Fabric service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., EnableBackupDescription: any # Specifies the parameters for enabling backup.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the request to enable service backup has been accepted. @endpoint POST /Services/{serviceId}/$/DisableBackup @desc Disables periodic backup of Service Fabric service which was previously enabled. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {DisableBackupDescription: any # Specifies the parameters to disable backup for any backup entity., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the request to disable service backup has been accepted. @endpoint GET /Services/{serviceId}/$/GetBackupConfigurationInfo @desc Gets the Service Fabric service backup configuration information. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and a paged list of backup configuration information for the service, and the partitions under this service, for which backup configuration has been overridden. @endpoint GET /Services/{serviceId}/$/GetBackups @desc Gets the list of backups available for every partition in this service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., Latest: any # Specifies whether to get only the most recent backup available for a partition for the specified time range., StartDateTimeFilter: any # Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated., EndDateTimeFilter: any # Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.} @returns(200) A successful operation will return 200 status code and a paged list of backup information. @endpoint POST /Services/{serviceId}/$/SuspendBackup @desc Suspends periodic backup for the specified Service Fabric service. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation request was accepted and service backup will be suspended. @endpoint POST /Services/{serviceId}/$/ResumeBackup @desc Resumes periodic backup of a Service Fabric service which was previously suspended. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation request was accepted and service backup will be resumed. @endgroup @group Partitions @endpoint POST /Partitions/{partitionId}/$/EnableBackup @desc Enables periodic backup of the stateful persisted partition. @required {partitionId: any # The identity of the partition., EnableBackupDescription: any # Specifies the parameters for enabling backup.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the request to enable partition backup has been accepted. @endpoint POST /Partitions/{partitionId}/$/DisableBackup @desc Disables periodic backup of Service Fabric partition which was previously enabled. @required {partitionId: any # The identity of the partition.} @optional {DisableBackupDescription: any # Specifies the parameters to disable backup for any backup entity., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the request to disable partition backup has been accepted. @endpoint GET /Partitions/{partitionId}/$/GetBackupConfigurationInfo @desc Gets the partition backup configuration information @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation will return 200 status code and gets the partition's backup configuration information. @endpoint GET /Partitions/{partitionId}/$/GetBackups @desc Gets the list of backups available for the specified partition. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., Latest: any # Specifies whether to get only the most recent backup available for a partition for the specified time range., StartDateTimeFilter: any # Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated., EndDateTimeFilter: any # Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup.} @returns(200) A successful operation will return 200 status code and a paged list of backup information. @endpoint POST /Partitions/{partitionId}/$/SuspendBackup @desc Suspends periodic backup for the specified partition. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation request was accepted and partition backup will be suspended. @endpoint POST /Partitions/{partitionId}/$/ResumeBackup @desc Resumes periodic backup of partition which was previously suspended. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation request was accepted and partition backup will be resumed. @endpoint POST /Partitions/{partitionId}/$/Backup @desc Triggers backup of the partition's state. @required {partitionId: any # The identity of the partition.} @optional {BackupPartitionDescription: any # Describes the parameters to backup the partition now. If not present, backup operation uses default parameters from the backup policy current associated with this partition., BackupTimeout: any # Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation request was accepted and backup will be initiated. Use GetPartitionBackupProgress operation to get the status of the backup operation. @endpoint GET /Partitions/{partitionId}/$/GetBackupProgress @desc Gets details for the latest backup triggered for this partition. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation returns 200 status code and backup progress details. @endpoint POST /Partitions/{partitionId}/$/Restore @desc Triggers restore of the state of the partition using the specified restore partition description. @required {partitionId: any # The identity of the partition., RestorePartitionDescription: any # Describes the parameters to restore the partition.} @optional {RestoreTimeout: any # Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(202) A 202 status code indicates the operation request was accepted and restore will be initiated. Use GetPartitionRestoreProgress operation to get the status of the restore operation. @endpoint GET /Partitions/{partitionId}/$/GetRestoreProgress @desc Gets details for the latest restore operation triggered for this partition. @required {partitionId: any # The identity of the partition.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful operation returns 200 status code and restore progress details. @endgroup @group BackupRestore @endpoint POST /BackupRestore/$/GetBackups @desc Gets the list of backups available for the specified backed up entity at the specified backup location. @required {GetBackupByStorageQueryDescription: any # Describes the filters and backup storage details to be used for enumerating backups.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., MaxResults: any # The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.} @returns(200) A successful operation will return 200 status code and a paged list of backup information. @endgroup @group Names @endpoint POST /Names/$/Create @desc Creates a Service Fabric name. @required {NameDescription: any # Describes the Service Fabric name to be created.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(201) A successful response means that the name has been created. @endpoint GET /Names/{nameId} @desc Returns whether the Service Fabric name exists. @required {nameId: any # The Service Fabric name, without the 'fabric:' URI scheme.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the Service Fabric name exists. @endpoint DELETE /Names/{nameId} @desc Deletes a Service Fabric name. @required {nameId: any # The Service Fabric name, without the 'fabric:' URI scheme.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the Service Fabric name has been deleted. @endpoint GET /Names/{nameId}/$/GetSubNames @desc Enumerates all the Service Fabric names under a given name. @required {nameId: any # The Service Fabric name, without the 'fabric:' URI scheme.} @optional {Recursive: any # Allows specifying that the search performed should be recursive., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A paged list of Service Fabric names. @endpoint GET /Names/{nameId}/$/GetProperties @desc Gets information on all Service Fabric properties under a given name. @required {nameId: any # The Service Fabric name, without the 'fabric:' URI scheme.} @optional {IncludeValues: any # Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata., ContinuationToken: any # The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded., timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A paged list of Service Fabric properties. @endpoint PUT /Names/{nameId}/$/GetProperty @desc Creates or updates a Service Fabric property. @required {nameId: any # The Service Fabric name, without the 'fabric:' URI scheme., PropertyDescription: any # Describes the Service Fabric property to be created.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the property has been created or updated. @endpoint GET /Names/{nameId}/$/GetProperty @desc Gets the specified Service Fabric property. @required {nameId: any # The Service Fabric name, without the 'fabric:' URI scheme., PropertyName: any # Specifies the name of the property to get.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) Details on the Service Fabric property. @endpoint DELETE /Names/{nameId}/$/GetProperty @desc Deletes the specified Service Fabric property. @required {nameId: any # The Service Fabric name, without the 'fabric:' URI scheme., PropertyName: any # Specifies the name of the property to get.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the property has been deleted. @endpoint POST /Names/{nameId}/$/GetProperties/$/SubmitBatch @desc Submits a property batch. @required {nameId: any # The Service Fabric name, without the 'fabric:' URI scheme., PropertyBatchDescriptionList: any # Describes the property batch operations to be submitted.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) A successful response means that the property batch succeeded. @errors {409: A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were committed.} @endgroup @group EventsStore @endpoint GET /EventsStore/Cluster/Events @desc Gets all Cluster-related events. @required {StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type ClusterEvent. @endpoint GET /EventsStore/Containers/Events @desc Gets all Containers-related events. @required {StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type ContainerInstanceEvent. @endpoint GET /EventsStore/Nodes/{nodeName}/$/Events @desc Gets a Node-related events. @required {nodeName: any # The name of the node., StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type NodeEvent. @endpoint GET /EventsStore/Nodes/Events @desc Gets all Nodes-related Events. @required {StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type NodeEvent. @endpoint GET /EventsStore/Applications/{applicationId}/$/Events @desc Gets an Application-related events. @required {applicationId: any # The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions., StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type ApplicationEvent. @endpoint GET /EventsStore/Applications/Events @desc Gets all Applications-related events. @required {StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type ApplicationEvent. @endpoint GET /EventsStore/Services/{serviceId}/$/Events @desc Gets a Service-related events. @required {serviceId: any # The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions., StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type ServiceEvent. @endpoint GET /EventsStore/Services/Events @desc Gets all Services-related events. @required {StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type ServiceEvent. @endpoint GET /EventsStore/Partitions/{partitionId}/$/Events @desc Gets a Partition-related events. @required {partitionId: any # The identity of the partition., StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type PartitionEvent. @endpoint GET /EventsStore/Partitions/Events @desc Gets all Partitions-related events. @required {StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type PartitionEvent. @endpoint GET /EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/Events @desc Gets a Partition Replica-related events. @required {partitionId: any # The identity of the partition., replicaId: any # The identifier of the replica., StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type ReplicaEvent. @endpoint GET /EventsStore/Partitions/{partitionId}/$/Replicas/Events @desc Gets all Replicas-related events for a Partition. @required {partitionId: any # The identity of the partition., StartTimeUtc: any # The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ., EndTimeUtc: any # The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds., EventsTypesFilter: any # This is a comma separated string specifying the types of FabricEvents that should only be included in the response., ExcludeAnalysisEvents: any # This param disables the retrieval of AnalysisEvents if true is passed., SkipCorrelationLookup: any # This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.} @returns(200) List of events objects with base type ReplicaEvent. @endpoint GET /EventsStore/CorrelatedEvents/{eventInstanceId}/$/Events @desc Gets all correlated events for a given event. @required {eventInstanceId: any # The EventInstanceId.} @optional {timeout: any # The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.} @returns(200) List of events objects with base type FabricEvent. @endgroup @group Resources @endpoint PUT /Resources/Secrets/{secretResourceName} @desc Creates or updates a Secret resource. @required {secretResourceName: any # The name of the secret resource., secretResourceDescription: any # Description for creating a secret resource.} @returns(200) OK @returns(201) Created @returns(202) Accepted @endpoint GET /Resources/Secrets/{secretResourceName} @desc Gets the Secret resource with the given name. @required {secretResourceName: any # The name of the secret resource.} @returns(200) OK @endpoint DELETE /Resources/Secrets/{secretResourceName} @desc Deletes the Secret resource. @required {secretResourceName: any # The name of the secret resource.} @returns(200) OK @returns(202) Accepted @returns(204) No Content - the specified secret was not found. @endpoint GET /Resources/Secrets @desc Lists all the secret resources. @returns(200) OK @endpoint PUT /Resources/Secrets/{secretResourceName}/values/{secretValueResourceName} @desc Adds the specified value as a new version of the specified secret resource. @required {secretResourceName: any # The name of the secret resource., secretValueResourceName: any # The name of the secret resource value which is typically the version identifier for the value., secretValueResourceDescription: any # Description for creating a value of a secret resource.} @returns(200) OK @returns(201) Created @returns(202) Accepted @endpoint GET /Resources/Secrets/{secretResourceName}/values/{secretValueResourceName} @desc Gets the specified secret value resource. @required {secretResourceName: any # The name of the secret resource., secretValueResourceName: any # The name of the secret resource value which is typically the version identifier for the value.} @returns(200) OK @endpoint DELETE /Resources/Secrets/{secretResourceName}/values/{secretValueResourceName} @desc Deletes the specified value of the named secret resource. @required {secretResourceName: any # The name of the secret resource., secretValueResourceName: any # The name of the secret resource value which is typically the version identifier for the value.} @returns(200) OK @returns(202) Accepted @returns(204) No Content - the specified secret value was not found. @endpoint GET /Resources/Secrets/{secretResourceName}/values @desc List names of all values of the specified secret resource. @required {secretResourceName: any # The name of the secret resource.} @returns(200) OK @endpoint POST /Resources/Secrets/{secretResourceName}/values/{secretValueResourceName}/list_value @desc Lists the specified value of the secret resource. @required {secretResourceName: any # The name of the secret resource., secretValueResourceName: any # The name of the secret resource value which is typically the version identifier for the value.} @returns(200) OK @endpoint PUT /Resources/Volumes/{volumeResourceName} @desc Creates or updates a Volume resource. @required {volumeResourceName: any # The identity of the volume., volumeResourceDescription: any # Description for creating a Volume resource.} @returns(200) OK @returns(201) Created @returns(202) Accepted @endpoint GET /Resources/Volumes/{volumeResourceName} @desc Gets the Volume resource with the given name. @required {volumeResourceName: any # The identity of the volume.} @returns(200) OK @endpoint DELETE /Resources/Volumes/{volumeResourceName} @desc Deletes the Volume resource. @required {volumeResourceName: any # The identity of the volume.} @returns(200) OK @returns(202) Accepted @returns(204) No Content - the specified volume was not found. @endpoint GET /Resources/Volumes @desc Lists all the volume resources. @returns(200) OK @endpoint PUT /Resources/Networks/{networkResourceName} @desc Creates or updates a Network resource. @required {networkResourceName: any # The identity of the network., networkResourceDescription: any # Description for creating a Network resource.} @returns(200) OK @returns(201) Created @returns(202) Accepted @endpoint GET /Resources/Networks/{networkResourceName} @desc Gets the Network resource with the given name. @required {networkResourceName: any # The identity of the network.} @returns(200) OK @endpoint DELETE /Resources/Networks/{networkResourceName} @desc Deletes the Network resource. @required {networkResourceName: any # The identity of the network.} @returns(200) OK @returns(202) Accepted @returns(204) No Content - the specified network was not found. @endpoint GET /Resources/Networks @desc Lists all the network resources. @returns(200) OK @endpoint PUT /Resources/Applications/{applicationResourceName} @desc Creates or updates a Application resource. @required {applicationResourceName: any # The identity of the application., applicationResourceDescription: any # Description for creating a Application resource.} @returns(200) OK @returns(201) Created @returns(202) Accepted @endpoint GET /Resources/Applications/{applicationResourceName} @desc Gets the Application resource with the given name. @required {applicationResourceName: any # The identity of the application.} @returns(200) OK @endpoint DELETE /Resources/Applications/{applicationResourceName} @desc Deletes the Application resource. @required {applicationResourceName: any # The identity of the application.} @returns(200) OK @returns(202) Accepted @returns(204) No Content - the specified application was not found. @endpoint GET /Resources/Applications @desc Lists all the application resources. @returns(200) OK @endpoint GET /Resources/Applications/{applicationResourceName}/Services/{serviceResourceName} @desc Gets the Service resource with the given name. @required {applicationResourceName: any # The identity of the application., serviceResourceName: any # The identity of the service.} @returns(200) OK @endpoint GET /Resources/Applications/{applicationResourceName}/Services @desc Lists all the service resources. @required {applicationResourceName: any # The identity of the application.} @returns(200) OK @endpoint GET /Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName}/CodePackages/{codePackageName}/Logs @desc Gets the logs from the container. @required {applicationResourceName: any # The identity of the application., serviceResourceName: any # The identity of the service., replicaName: any # Service Fabric replica name., codePackageName: any # The name of code package of the service.} @optional {Tail: any # Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs.} @returns(200) OK @endpoint GET /Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName} @desc Gets the given replica of the service of an application. @required {applicationResourceName: any # The identity of the application., serviceResourceName: any # The identity of the service., replicaName: any # Service Fabric replica name.} @returns(200) OK @endpoint GET /Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas @desc Lists all the replicas of a service. @required {applicationResourceName: any # The identity of the application., serviceResourceName: any # The identity of the service.} @returns(200) OK @endpoint PUT /Resources/Gateways/{gatewayResourceName} @desc Creates or updates a Gateway resource. @required {gatewayResourceName: any # The identity of the gateway., gatewayResourceDescription: any # Description for creating a Gateway resource.} @returns(200) OK @returns(201) Created @returns(202) Accepted @endpoint GET /Resources/Gateways/{gatewayResourceName} @desc Gets the Gateway resource with the given name. @required {gatewayResourceName: any # The identity of the gateway.} @returns(200) OK @endpoint DELETE /Resources/Gateways/{gatewayResourceName} @desc Deletes the Gateway resource. @required {gatewayResourceName: any # The identity of the gateway.} @returns(200) OK @returns(202) Accepted @returns(204) No Content - the specified gateway was not found. @endpoint GET /Resources/Gateways @desc Lists all the gateway resources. @returns(200) OK @endgroup @end