swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Compose Deployment API schemes: - https tags: - name: Compose Deployment paths: /ComposeDeployments/$/Create: put: summary: Microsoft Azure Creates A Service Fabric Compose Deployment description: Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created, its status can be tracked via the `GetComposeDeploymentStatus` API. operationId: microsoftAzureCreatecomposedeployment parameters: - $ref: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam' - $ref: '#/parameters/CreateComposeDeploymentRequiredBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Compose Deployment responses: '202': description: A successful operation will return 202 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /ComposeDeployments/{deploymentName}: get: summary: Microsoft Azure Gets Information About A Service Fabric Compose Deployment description: Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status, and other details about the deployment. operationId: microsoftAzureGetcomposedeploymentstatus parameters: - $ref: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam' - $ref: '#/parameters/DeploymentNameRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Compose Deployment responses: '200': description: Information about the compose deployment. schema: $ref: '#/definitions/ComposeDeploymentStatusInfo' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /ComposeDeployments: get: summary: Microsoft Azure Gets The List Of Compose Deployments Created In The Service Fabric Cluster description: Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. operationId: microsoftAzureGetcomposedeploymentstatuslist parameters: - $ref: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Compose Deployment responses: '200': description: List of status of compose deployments in the cluster. schema: $ref: '#/definitions/PagedComposeDeploymentStatusInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /ComposeDeployments/{deploymentName}/$/GetUpgradeProgress: get: summary: Microsoft Azure Gets Details For The Latest Upgrade Performed On This Service Fabric Compose Deployment description: Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues. operationId: microsoftAzureGetcomposedeploymentupgradeprogress parameters: - $ref: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam' - $ref: '#/parameters/DeploymentNameRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Compose Deployment responses: '200': description: Details about the compose deployment upgrade. schema: $ref: '#/definitions/ComposeDeploymentUpgradeProgressInfo' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /ComposeDeployments/{deploymentName}/$/Delete: post: summary: Microsoft Azure Deletes An Existing Service Fabric Compose Deployment From Cluster description: Deletes an existing Service Fabric compose deployment. operationId: microsoftAzureRemovecomposedeployment parameters: - $ref: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam' - $ref: '#/parameters/DeploymentNameRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Compose Deployment responses: '202': description: A successful operation will return 202 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /ComposeDeployments/{deploymentName}/$/Upgrade: post: summary: Microsoft Azure Starts Upgrading A Compose Deployment In The Service Fabric Cluster description: Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid. operationId: microsoftAzureStartcomposedeploymentupgrade parameters: - $ref: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam' - $ref: '#/parameters/DeploymentNameRequiredPathParam' - $ref: '#/parameters/ComposeDeploymentUpgradeDescriptionRequiredBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Compose Deployment responses: '202': description: A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /ComposeDeployments/{deploymentName}/$/RollbackUpgrade: post: summary: Microsoft Azure Starts Rolling Back A Compose Deployment Upgrade In The Service Fabric Cluster description: Rollback a service fabric compose deployment upgrade. operationId: microsoftAzureStartrollbackcomposedeploymentupgrade parameters: - $ref: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam' - $ref: '#/parameters/DeploymentNameRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Compose Deployment responses: '200': description: A successful response means that the rollback has started. Use GetComposeDeploymentUpgrade operation to get the status of the rollback. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' definitions: TargetDeploymentName: type: string description: The name of the target deployment. ComposeDeploymentStatus: type: string description: The status of the compose deployment. enum: - Invalid - Provisioning - Creating - Ready - Unprovisioning - Deleting - Failed - Upgrading x-ms-enum: name: ComposeDeploymentStatus modelAsString: true values: - value: Invalid description: Indicates that the compose deployment status is invalid. The value is zero. - value: Provisioning description: Indicates that the compose deployment is being provisioned in background. The value is 1. - value: Creating description: Indicates that the compose deployment is being created in background. The value is 2. - value: Ready description: Indicates that the compose deployment has been successfully created or upgraded. The value is 3. - value: Unprovisioning description: Indicates that the compose deployment is being unprovisioned in background. The value is 4. - value: Deleting description: Indicates that the compose deployment is being deleted in background. The value is 5. - value: Failed description: Indicates that the compose deployment was terminated due to persistent failures. The value is 6. - value: Upgrading description: Indicates that the compose deployment is being upgraded in the background. The value is 7. UpgradeReplicaSetCheckTimeout: type: integer format: int64 description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). default: 42949672925 FabricErrorError: description: Error object containing error code and error message. properties: Code: $ref: '#/definitions/FabricErrorCodes' description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" Message: type: string description: Error message. required: - Code TargetApplicationName: type: string description: The name of the target application, including the 'fabric:' URI scheme. HealthCheckWaitDuration: type: string description: The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. default: '0' ComposeDeploymentUpgradeState: type: string description: The state of the compose deployment upgrade. enum: - Invalid - ProvisioningTarget - RollingForwardInProgress - RollingForwardPending - UnprovisioningCurrent - RollingForwardCompleted - RollingBackInProgress - UnprovisioningTarget - RollingBackCompleted - Failed x-ms-enum: name: ComposeDeploymentUpgradeState modelAsString: true values: - value: Invalid description: Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: ProvisioningTarget description: The upgrade is in the progress of provisioning target application type version. The value is 1. - value: RollingForwardInProgress description: The upgrade is rolling forward to the target version but is not complete yet. The value is 2. - value: RollingForwardPending description: The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3 - value: UnprovisioningCurrent description: The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4. - value: RollingForwardCompleted description: The upgrade has finished rolling forward. The value is 5. - value: RollingBackInProgress description: The upgrade is rolling back to the previous version but is not complete yet. The value is 6. - value: UnprovisioningTarget description: The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7. - value: RollingBackCompleted description: The upgrade has finished rolling back. The value is 8. - value: Failed description: The upgrade has failed and is unable to execute FailureAction. The value is 9. HealthEvaluation: discriminator: Kind description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity. properties: Kind: $ref: '#/definitions/HealthEvaluationKind' description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values. AggregatedHealthState: $ref: '#/definitions/HealthState' description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Description: type: string description: Description of the health evaluation, which represents a summary of the evaluation process. required: - Kind ApplicationUnhealthyEvaluations: description: List of health evaluations that resulted in the current aggregated health state. type: array items: $ref: '#/definitions/HealthEvaluationWrapper' HealthEvaluationWrapper: description: Wrapper object for health evaluation. properties: HealthEvaluation: $ref: '#/definitions/HealthEvaluation' description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity. SafetyCheck: discriminator: Kind description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. properties: Kind: $ref: '#/definitions/SafetyCheckKind' description: The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks. required: - Kind HealthEvaluationKind: type: string description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values. enum: - Invalid - Event - Replicas - Partitions - DeployedServicePackages - DeployedApplications - Services - Nodes - Applications - SystemApplication - UpgradeDomainDeployedApplications - UpgradeDomainNodes - Replica - Partition - DeployedServicePackage - DeployedApplication - Service - Node - Application - DeltaNodesCheck - UpgradeDomainDeltaNodesCheck - ApplicationTypeApplications - NodeTypeNodes x-ms-enum: name: HealthEvaluationKind modelAsString: true values: - value: Invalid description: Indicates that the health evaluation is invalid. The value is zero. - value: Event description: Indicates that the health evaluation is for a health event. The value is 1. - value: Replicas description: Indicates that the health evaluation is for the replicas of a partition. The value is 2. - value: Partitions description: Indicates that the health evaluation is for the partitions of a service. The value is 3. - value: DeployedServicePackages description: Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4. - value: DeployedApplications description: Indicates that the health evaluation is for the deployed applications of an application. The value is 5. - value: Services description: Indicates that the health evaluation is for services of an application. The value is 6. - value: Nodes description: Indicates that the health evaluation is for the cluster nodes. The value is 7. - value: Applications description: Indicates that the health evaluation is for the cluster applications. The value is 8. - value: SystemApplication description: Indicates that the health evaluation is for the system application. The value is 9. - value: UpgradeDomainDeployedApplications description: Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10. - value: UpgradeDomainNodes description: Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11. - value: Replica description: Indicates that the health evaluation is for a replica. The value is 13. - value: Partition description: Indicates that the health evaluation is for a partition. The value is 14. - value: DeployedServicePackage description: Indicates that the health evaluation is for a deployed service package. The value is 16. - value: DeployedApplication description: Indicates that the health evaluation is for a deployed application. The value is 17. - value: Service description: Indicates that the health evaluation is for a service. The value is 15. - value: Node description: Indicates that the health evaluation is for a node. The value is 12. - value: Application description: Indicates that the health evaluation is for an application. The value is 18. - value: DeltaNodesCheck description: Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19. - value: UpgradeDomainDeltaNodesCheck description: Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20. - value: ApplicationTypeApplications description: – Indicates that the health evaluation is for applications of an application type. The value is 21. - value: NodeTypeNodes description: – Indicates that the health evaluation is for nodes of a node type. The value is 22. SafetyCheckWrapper: description: A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. properties: SafetyCheck: $ref: '#/definitions/SafetyCheck' description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. FailureUpgradeDomainProgressInfo: description: Information about the upgrade domain progress at the time of upgrade failure. properties: DomainName: $ref: '#/definitions/UpgradeDomainName' description: The name of the upgrade domain NodeUpgradeProgressList: $ref: '#/definitions/NodeUpgradeProgressInfoList' description: List of upgrading nodes and their statuses NodeUpgradePhase: type: string description: The state of the upgrading node. enum: - Invalid - PreUpgradeSafetyCheck - Upgrading - PostUpgradeSafetyCheck x-ms-enum: name: NodeUpgradePhase modelAsString: true values: - value: Invalid description: Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: PreUpgradeSafetyCheck description: The upgrade has not started yet due to pending safety checks. The value is 1 - value: Upgrading description: The upgrade is in progress. The value is 2 - value: PostUpgradeSafetyCheck description: The upgrade has completed and post upgrade safety checks are being performed. The value is 3 HealthState: type: string description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. enum: - Invalid - Ok - Warning - Error - Unknown x-ms-enum: name: HealthState modelAsString: true values: - value: Invalid description: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero. - value: Ok description: Indicates the health state is okay. The value is 1. - value: Warning description: Indicates the health state is at a warning level. The value is 2. - value: Error description: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3. - value: Unknown description: Indicates an unknown health status. The value is 65535. ServiceTypeHealthPolicyMap: type: array items: $ref: '#/definitions/ServiceTypeHealthPolicyMapItem' description: 'Defines a ServiceTypeHealthPolicy per service type name. The entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there''s more granular control of the health of the service. If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.' UpgradeDomainName: type: string description: The name of the upgrade domain ComposeDeploymentUpgradeDescription: description: Describes the parameters for a compose deployment upgrade. properties: DeploymentName: $ref: '#/definitions/DeploymentName' description: The name of the deployment. ComposeFileContent: type: string description: The content of the compose file that describes the deployment to create. RegistryCredential: $ref: '#/definitions/RegistryCredential' description: Credential information to connect to container registry. UpgradeKind: $ref: '#/definitions/UpgradeKind' description: The kind of upgrade out of the following possible values. RollingUpgradeMode: $ref: '#/definitions/UpgradeMode' description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. UpgradeReplicaSetCheckTimeoutInSeconds: $ref: '#/definitions/UpgradeReplicaSetCheckTimeout' description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). ForceRestart: $ref: '#/definitions/ForceRestart' description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). MonitoringPolicy: $ref: '#/definitions/MonitoringPolicyDescription' description: Describes the parameters for monitoring an upgrade in Monitored mode. ApplicationHealthPolicy: $ref: '#/definitions/ApplicationHealthPolicy' description: Defines a health policy used to evaluate the health of an application or one of its children entities. required: - DeploymentName - ComposeFileContent - UpgradeKind UpgradeKind: type: string description: The kind of upgrade out of the following possible values. default: Rolling enum: - Invalid - Rolling x-ms-enum: name: UpgradeKind modelAsString: true values: - value: Invalid description: Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Rolling description: The upgrade progresses one upgrade domain at a time. The value is 1 ApplicationName: type: string description: The name of the application, including the 'fabric:' URI scheme. ServiceTypeHealthPolicyMapItem: description: Defines an item in ServiceTypeHealthPolicyMap. required: - Key - Value properties: Key: type: string description: The key of the service type health policy map item. This is the name of the service type. Value: $ref: '#/definitions/ServiceTypeHealthPolicy' description: The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type. FabricErrorCodes: type: string description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" enum: - FABRIC_E_INVALID_PARTITION_KEY - FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR - FABRIC_E_INVALID_ADDRESS - FABRIC_E_APPLICATION_NOT_UPGRADING - FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR - FABRIC_E_FABRIC_NOT_UPGRADING - FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR - FABRIC_E_INVALID_CONFIGURATION - FABRIC_E_INVALID_NAME_URI - FABRIC_E_PATH_TOO_LONG - FABRIC_E_KEY_TOO_LARGE - FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED - FABRIC_E_INVALID_ATOMIC_GROUP - FABRIC_E_VALUE_EMPTY - FABRIC_E_NODE_NOT_FOUND - FABRIC_E_APPLICATION_TYPE_NOT_FOUND - FABRIC_E_APPLICATION_NOT_FOUND - FABRIC_E_SERVICE_TYPE_NOT_FOUND - FABRIC_E_SERVICE_DOES_NOT_EXIST - FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND - FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND - FABRIC_E_PARTITION_NOT_FOUND - FABRIC_E_REPLICA_DOES_NOT_EXIST - FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST - FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND - FABRIC_E_DIRECTORY_NOT_FOUND - FABRIC_E_FABRIC_VERSION_NOT_FOUND - FABRIC_E_FILE_NOT_FOUND - FABRIC_E_NAME_DOES_NOT_EXIST - FABRIC_E_PROPERTY_DOES_NOT_EXIST - FABRIC_E_ENUMERATION_COMPLETED - FABRIC_E_SERVICE_MANIFEST_NOT_FOUND - FABRIC_E_KEY_NOT_FOUND - FABRIC_E_HEALTH_ENTITY_NOT_FOUND - FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS - FABRIC_E_APPLICATION_ALREADY_EXISTS - FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION - FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS - FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS - FABRIC_E_SERVICE_ALREADY_EXISTS - FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS - FABRIC_E_APPLICATION_TYPE_IN_USE - FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION - FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS - FABRIC_E_FABRIC_VERSION_IN_USE - FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS - FABRIC_E_NAME_ALREADY_EXISTS - FABRIC_E_NAME_NOT_EMPTY - FABRIC_E_PROPERTY_CHECK_FAILED - FABRIC_E_SERVICE_METADATA_MISMATCH - FABRIC_E_SERVICE_TYPE_MISMATCH - FABRIC_E_HEALTH_STALE_REPORT - FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED - FABRIC_E_NODE_HAS_NOT_STOPPED_YET - FABRIC_E_INSTANCE_ID_MISMATCH - FABRIC_E_VALUE_TOO_LARGE - FABRIC_E_NO_WRITE_QUORUM - FABRIC_E_NOT_PRIMARY - FABRIC_E_NOT_READY - FABRIC_E_RECONFIGURATION_PENDING - FABRIC_E_SERVICE_OFFLINE - E_ABORT - FABRIC_E_COMMUNICATION_ERROR - FABRIC_E_OPERATION_NOT_COMPLETE - FABRIC_E_TIMEOUT - FABRIC_E_NODE_IS_UP - E_FAIL - FABRIC_E_BACKUP_IS_ENABLED - FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH - FABRIC_E_INVALID_FOR_STATELESS_SERVICES - FABRIC_E_BACKUP_NOT_ENABLED - FABRIC_E_BACKUP_POLICY_NOT_EXISTING - FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING - FABRIC_E_BACKUP_IN_PROGRESS - FABRIC_E_RESTORE_IN_PROGRESS - FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING - FABRIC_E_INVALID_SERVICE_SCALING_POLICY - E_INVALIDARG - FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS - FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND - FABRIC_E_VOLUME_ALREADY_EXISTS - FABRIC_E_VOLUME_NOT_FOUND - SerializationError - FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR x-ms-enum: name: FabricErrorCodes modelAsString: true values: - value: FABRIC_E_INVALID_PARTITION_KEY - value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR - value: FABRIC_E_INVALID_ADDRESS - value: FABRIC_E_APPLICATION_NOT_UPGRADING - value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR - value: FABRIC_E_FABRIC_NOT_UPGRADING - value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR - value: FABRIC_E_INVALID_CONFIGURATION - value: FABRIC_E_INVALID_NAME_URI - value: FABRIC_E_PATH_TOO_LONG - value: FABRIC_E_KEY_TOO_LARGE - value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED - value: FABRIC_E_INVALID_ATOMIC_GROUP - value: FABRIC_E_VALUE_EMPTY - value: FABRIC_E_NODE_NOT_FOUND - value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND - value: FABRIC_E_APPLICATION_NOT_FOUND - value: FABRIC_E_SERVICE_TYPE_NOT_FOUND - value: FABRIC_E_SERVICE_DOES_NOT_EXIST - value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND - value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND - value: FABRIC_E_PARTITION_NOT_FOUND - value: FABRIC_E_REPLICA_DOES_NOT_EXIST - value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST - value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND - value: FABRIC_E_DIRECTORY_NOT_FOUND - value: FABRIC_E_FABRIC_VERSION_NOT_FOUND - value: FABRIC_E_FILE_NOT_FOUND - value: FABRIC_E_NAME_DOES_NOT_EXIST - value: FABRIC_E_PROPERTY_DOES_NOT_EXIST - value: FABRIC_E_ENUMERATION_COMPLETED - value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND - value: FABRIC_E_KEY_NOT_FOUND - value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND - value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS - value: FABRIC_E_APPLICATION_ALREADY_EXISTS - value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION - value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS - value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS - value: FABRIC_E_SERVICE_ALREADY_EXISTS - value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS - value: FABRIC_E_APPLICATION_TYPE_IN_USE - value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION - value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS - value: FABRIC_E_FABRIC_VERSION_IN_USE - value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS - value: FABRIC_E_NAME_ALREADY_EXISTS - value: FABRIC_E_NAME_NOT_EMPTY - value: FABRIC_E_PROPERTY_CHECK_FAILED - value: FABRIC_E_SERVICE_METADATA_MISMATCH - value: FABRIC_E_SERVICE_TYPE_MISMATCH - value: FABRIC_E_HEALTH_STALE_REPORT - value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED - value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET - value: FABRIC_E_INSTANCE_ID_MISMATCH - value: FABRIC_E_VALUE_TOO_LARGE - value: FABRIC_E_NO_WRITE_QUORUM - value: FABRIC_E_NOT_PRIMARY - value: FABRIC_E_NOT_READY - value: FABRIC_E_RECONFIGURATION_PENDING - value: FABRIC_E_SERVICE_OFFLINE - value: E_ABORT - value: FABRIC_E_COMMUNICATION_ERROR - value: FABRIC_E_OPERATION_NOT_COMPLETE - value: FABRIC_E_TIMEOUT - value: FABRIC_E_NODE_IS_UP - value: E_FAIL - value: FABRIC_E_BACKUP_IS_ENABLED - value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH - value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES - value: FABRIC_E_BACKUP_NOT_ENABLED - value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING - value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING - value: FABRIC_E_BACKUP_IN_PROGRESS - value: FABRIC_E_RESTORE_IN_PROGRESS - value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING - value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY - value: E_INVALIDARG - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND - value: FABRIC_E_VOLUME_ALREADY_EXISTS - value: FABRIC_E_VOLUME_NOT_FOUND - value: SerializationError - value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR NodeUpgradeProgressInfo: description: Information about the upgrading node and its status properties: NodeName: $ref: '#/definitions/NodeName' description: The name of a Service Fabric node. UpgradePhase: $ref: '#/definitions/NodeUpgradePhase' description: The state of the upgrading node. PendingSafetyChecks: $ref: '#/definitions/SafetyCheckInfoList' description: List of pending safety checks UpgradeDuration: $ref: '#/definitions/NodeUpgradeDurationString' description: The estimated time spent processing the node since it was deactivated during a node-by-node upgrade. ContinuationToken: type: string description: The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response. UpgradeDomainTimeout: type: string description: The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. default: P10675199DT02H48M05.4775807S FabricError: description: The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful. properties: Error: $ref: '#/definitions/FabricErrorError' description: Error object containing error code and error message. required: - Error ForceRestart: type: boolean description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). default: false FailureReason: type: string description: The cause of an upgrade failure that resulted in FailureAction being executed. enum: - None - Interrupted - HealthCheck - UpgradeDomainTimeout - OverallUpgradeTimeout x-ms-enum: name: FailureReason modelAsString: true values: - value: None description: Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero. - value: Interrupted description: There was an external request to roll back the upgrade. The value is 1 - value: HealthCheck description: The upgrade failed due to health policy violations. The value is 2 - value: UpgradeDomainTimeout description: An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3 - value: OverallUpgradeTimeout description: The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4 HealthCheckRetryTimeout: type: string description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. default: PT0H10M0S HealthCheckStableDuration: type: string description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. default: PT0H2M0S ApplicationHealthPolicy: description: Defines a health policy used to evaluate the health of an application or one of its children entities. properties: ConsiderWarningAsError: type: boolean description: Indicates whether warnings are treated with the same severity as errors. default: false MaxPercentUnhealthyDeployedApplications: type: integer description: 'The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.' default: 0 DefaultServiceTypeHealthPolicy: $ref: '#/definitions/ServiceTypeHealthPolicy' description: The health policy used by default to evaluate the health of a service type. ServiceTypeHealthPolicyMap: $ref: '#/definitions/ServiceTypeHealthPolicyMap' description: The map with service type health policy per service type name. The map is empty by default. NodeUpgradeProgressInfoList: type: array description: List of upgrading nodes and their statuses items: $ref: '#/definitions/NodeUpgradeProgressInfo' SafetyCheckKind: type: string description: The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks. enum: - Invalid - EnsureSeedNodeQuorum - EnsurePartitionQuorum - WaitForPrimaryPlacement - WaitForPrimarySwap - WaitForReconfiguration - WaitForInbuildReplica - EnsureAvailability x-ms-enum: name: SafetyCheckKind modelAsString: true values: - value: Invalid description: Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: EnsureSeedNodeQuorum description: Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1. - value: EnsurePartitionQuorum description: Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2. - value: WaitForPrimaryPlacement description: Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3. - value: WaitForPrimarySwap description: Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4. - value: WaitForReconfiguration description: Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5. - value: WaitForInbuildReplica description: Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6. - value: EnsureAvailability description: Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7. ServiceTypeHealthPolicy: description: Represents the health policy used to evaluate the health of services belonging to a service type. properties: MaxPercentUnhealthyPartitionsPerService: type: integer description: 'The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.' default: 0 MaxPercentUnhealthyReplicasPerPartition: type: integer description: 'The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.' default: 0 MaxPercentUnhealthyServices: type: integer description: 'The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.' default: 0 DeploymentName: type: string description: The name of the deployment. UpgradeTimeout: type: string description: The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. default: P10675199DT02H48M05.4775807S ComposeDeploymentStatusInfo: description: Information about a Service Fabric compose deployment. properties: Name: $ref: '#/definitions/DeploymentName' description: The name of the deployment. ApplicationName: $ref: '#/definitions/ApplicationName' description: The name of the application, including the 'fabric:' URI scheme. Status: $ref: '#/definitions/ComposeDeploymentStatus' description: The status of the compose deployment. StatusDetails: description: The status details of compose deployment including failure message. type: string NodeName: type: string description: The name of a Service Fabric node. FailureAction: type: string description: 'The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.' enum: - Invalid - Rollback - Manual x-ms-enum: name: FailureAction modelAsString: true values: - value: Invalid description: Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Rollback description: The upgrade will start rolling back automatically. The value is 1 - value: Manual description: The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2 TargetApplicationTypeVersion: type: string description: The target application type version (found in the application manifest) for the application upgrade. CreateComposeDeploymentDescription: description: Defines description for creating a Service Fabric compose deployment. properties: DeploymentName: $ref: '#/definitions/DeploymentName' description: The name of the deployment. ComposeFileContent: type: string description: The content of the compose file that describes the deployment to create. RegistryCredential: $ref: '#/definitions/RegistryCredential' description: Credential information to connect to container registry. required: - DeploymentName - ComposeFileContent PagedComposeDeploymentStatusInfoList: description: The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response. Items: type: array description: List of compose deployment status information. items: $ref: '#/definitions/ComposeDeploymentStatusInfo' SafetyCheckInfoList: type: array description: List of pending safety checks items: $ref: '#/definitions/SafetyCheckWrapper' NodeUpgradeDurationString: type: string description: The estimated time spent processing the node since it was deactivated during a node-by-node upgrade. CurrentUpgradeDomainDuration: type: string description: The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. default: PT0H2M0S RegistryCredential: description: Credential information to connect to container registry. properties: RegistryUserName: type: string description: The user name to connect to container registry. RegistryPassword: type: string description: The password for supplied username to connect to container registry. PasswordEncrypted: type: boolean description: Indicates that supplied container registry password is encrypted. CurrentUpgradeDomainProgressInfo: description: Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades. properties: DomainName: $ref: '#/definitions/UpgradeDomainName' description: The name of the upgrade domain NodeUpgradeProgressList: $ref: '#/definitions/NodeUpgradeProgressInfoList' description: List of upgrading nodes and their statuses UpgradeDuration: type: string description: The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. default: PT0H2M0S ComposeDeploymentUpgradeProgressInfo: description: Describes the parameters for a compose deployment upgrade. properties: DeploymentName: $ref: '#/definitions/TargetDeploymentName' description: The name of the target deployment. ApplicationName: $ref: '#/definitions/TargetApplicationName' description: The name of the target application, including the 'fabric:' URI scheme. UpgradeState: $ref: '#/definitions/ComposeDeploymentUpgradeState' description: The state of the compose deployment upgrade. UpgradeStatusDetails: type: string description: Additional detailed information about the status of the pending upgrade. UpgradeKind: $ref: '#/definitions/UpgradeKind' description: The kind of upgrade out of the following possible values. RollingUpgradeMode: $ref: '#/definitions/UpgradeMode' description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. ForceRestart: $ref: '#/definitions/ForceRestart' description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). UpgradeReplicaSetCheckTimeoutInSeconds: $ref: '#/definitions/UpgradeReplicaSetCheckTimeout' description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). MonitoringPolicy: $ref: '#/definitions/MonitoringPolicyDescription' description: Describes the parameters for monitoring an upgrade in Monitored mode. ApplicationHealthPolicy: $ref: '#/definitions/ApplicationHealthPolicy' description: Defines a health policy used to evaluate the health of an application or one of its children entities. TargetApplicationTypeVersion: $ref: '#/definitions/TargetApplicationTypeVersion' description: The target application type version (found in the application manifest) for the application upgrade. UpgradeDuration: $ref: '#/definitions/UpgradeDuration' description: The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. CurrentUpgradeDomainDuration: $ref: '#/definitions/CurrentUpgradeDomainDuration' description: The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. ApplicationUnhealthyEvaluations: $ref: '#/definitions/ApplicationUnhealthyEvaluations' description: List of health evaluations that resulted in the current aggregated health state. CurrentUpgradeDomainProgress: $ref: '#/definitions/CurrentUpgradeDomainProgressInfo' description: Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades. StartTimestampUtc: type: string description: The estimated UTC datetime when the upgrade started. FailureTimestampUtc: type: string description: The estimated UTC datetime when the upgrade failed and FailureAction was executed. FailureReason: $ref: '#/definitions/FailureReason' description: The cause of an upgrade failure that resulted in FailureAction being executed. UpgradeDomainProgressAtFailure: $ref: '#/definitions/FailureUpgradeDomainProgressInfo' description: Information about the upgrade domain progress at the time of upgrade failure. ApplicationUpgradeStatusDetails: type: string description: Additional details of application upgrade including failure message. UpgradeMode: type: string description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. enum: - Invalid - UnmonitoredAuto - UnmonitoredManual - Monitored - UnmonitoredDeferred default: UnmonitoredAuto x-ms-enum: name: UpgradeMode modelAsString: true values: - value: Invalid description: Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: UnmonitoredAuto description: The upgrade will proceed automatically without performing any health monitoring. The value is 1 - value: UnmonitoredManual description: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2 - value: Monitored description: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3 - value: UnmonitoredDeferred description: Perform a node-by-node upgrade. No action is performed when upgrade starts; upgrade is applied on each node when it is deactivated with intent restart or higher. The value is 4 MonitoringPolicyDescription: description: Describes the parameters for monitoring an upgrade in Monitored mode. properties: FailureAction: $ref: '#/definitions/FailureAction' description: 'The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.' HealthCheckWaitDurationInMilliseconds: $ref: '#/definitions/HealthCheckWaitDuration' description: The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. HealthCheckStableDurationInMilliseconds: $ref: '#/definitions/HealthCheckStableDuration' description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. HealthCheckRetryTimeoutInMilliseconds: $ref: '#/definitions/HealthCheckRetryTimeout' description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. UpgradeTimeoutInMilliseconds: $ref: '#/definitions/UpgradeTimeout' description: The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. UpgradeDomainTimeoutInMilliseconds: $ref: '#/definitions/UpgradeDomainTimeout' description: The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. parameters: ApiVersion_6-4-Preview_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - 6.4-preview required: true default: 6.4-preview description: The version of the API. This parameter is required and its value must be '6.4-preview'. x-ms-enum: name: ApiVersion_6-4-Preview_RequiredQueryParam modelAsString: true values: - value: 6.4-preview description: The version number for the preview functionality of 6.4 runtime ApiVersion_6-0-Preview_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - 6.0-preview required: true default: 6.0-preview description: The version of the API. This parameter is required and its value must be '"6.0-preview'. x-ms-enum: name: ApiVersion_6-0-Preview_RequiredQueryParam modelAsString: true values: - value: 6.0-preview description: The version number for the preview functionality of 6.0 runtime. ComposeDeploymentUpgradeDescriptionRequiredBodyParam: name: ComposeDeploymentUpgradeDescription in: body description: Parameters for upgrading compose deployment. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/ComposeDeploymentUpgradeDescription' TimeoutOptionalQueryParam: name: timeout in: query x-ms-parameter-location: method type: integer format: int64 required: false minimum: 1 maximum: 4294967295 default: 60 description: 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. DeploymentNameRequiredPathParam: name: deploymentName in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: The identity of the deployment. CreateComposeDeploymentRequiredBodyParam: name: CreateComposeDeploymentDescription in: body description: Describes the compose deployment that needs to be created. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/CreateComposeDeploymentDescription' MaxResultsOptionalQueryParam: name: MaxResults in: query x-ms-parameter-location: method type: integer format: int64 minimum: 0 default: 0 required: false description: 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. ContinuationTokenOptionalQueryParam: name: ContinuationToken in: query x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: false description: 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. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'