swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Code Package API schemes: - https tags: - name: Code Package paths: /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages: get: operationId: microsoftAzureGetdeployedcodepackageinfolist summary: Microsoft Azure Gets The List Of Code Packages Deployed On A Service Fabric Node description: Gets the list of code packages deployed on a Service Fabric node for the given application. tags: - Code Package parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NodeNameRequiredPathParam' - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ServiceManifestNameOptionalQueryParam' - $ref: '#/parameters/CodePackageNameOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation will return 200 status code and the list of deployed code packages information. schema: $ref: '#/definitions/DeployedCodePackageInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart: post: operationId: microsoftAzureRestartdeployedcodepackage summary: Microsoft Azure Restarts A Code Package Deployed On A Service Fabric Node In A Cluster description: Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas hosted in that process. tags: - Code Package parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NodeNameRequiredPathParam' - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/RestartDeployedCodePackageRequiredBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs: get: operationId: microsoftAzureGetcontainerlogsdeployedonnode summary: Microsoft Azure Gets The Container Logs For Container Deployed On A Service Fabric Node description: Gets the container logs for container deployed on a Service Fabric node for the given code package. tags: - Code Package parameters: - $ref: '#/parameters/ApiVersion_6-2_RequiredQueryParam' - $ref: '#/parameters/NodeNameRequiredPathParam' - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ServiceManifestNameRequiredQueryParam' - $ref: '#/parameters/CodePackageNameRequiredQueryParam' - $ref: '#/parameters/TailOptionalQueryParam' - $ref: '#/parameters/PreviousOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' x-ms-examples: Get container logs for given code package: $ref: ./examples/GetContainerLogsDeployedOnNode-1.json Get last 10 lines of container logs: $ref: ./examples/GetContainerLogsDeployedOnNode-2.json Get container logs of previous dead container for given code package: $ref: ./examples/GetContainerLogsDeployedOnNode-3.json responses: '200': description: 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. schema: $ref: '#/definitions/ContainerLogs' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi: post: operationId: microsoftAzureInvokecontainerapi summary: Microsoft Azure Invoke Container Api On A Container Deployed On A Service Fabric Node description: Invoke container API on a container deployed on a Service Fabric node for the given code package. x-ms-examples: Get container logs: $ref: ./examples/InvokeContainerApi.json Update container: $ref: ./examples/InvokeContainerApi_Post.json tags: - Code Package parameters: - $ref: '#/parameters/ApiVersion_6-2_RequiredQueryParam' - $ref: '#/parameters/NodeNameRequiredPathParam' - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ServiceManifestNameRequiredQueryParam' - $ref: '#/parameters/CodePackageNameRequiredQueryParam' - $ref: '#/parameters/CodePackageInstanceIdRequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/ContainerApiRequiredBodyParam' responses: '200': description: 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. schema: $ref: '#/definitions/ContainerApiResponse' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' definitions: ContainerApiRequestBody: description: parameters for making container API call. properties: HttpVerb: type: string description: HTTP verb of container REST API, defaults to "GET" UriPath: type: string description: URI path of container REST API Content-Type: type: string description: Content type of container REST API request, defaults to "application/json" Body: type: string description: HTTP request body of container REST API required: - UriPath ContainerApiResponse: description: Response body that wraps container API result. properties: ContainerApiResult: $ref: '#/definitions/ContainerApiResult' description: Container API result. required: - ContainerApiResult 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 ServicePackageActivationId: type: string description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId is always an empty string.' DeployedCodePackageInfoList: type: array items: $ref: '#/definitions/DeployedCodePackageInfo' description: List of deployed code package information. EntryPointStatus: type: string description: Specifies the status of the code package entry point deployed on a Service Fabric node. enum: - Invalid - Pending - Starting - Started - Stopping - Stopped x-ms-enum: name: EntryPointStatus modelAsString: true values: - value: Invalid description: Indicates status of entry point is not known or invalid. The value is 0. - value: Pending description: Indicates the entry point is scheduled to be started. The value is 1. - value: Starting description: Indicates the entry point is being started. The value is 2. - value: Started description: Indicates the entry point was started successfully and is running. The value is 3. - value: Stopping description: Indicates the entry point is being stopped. The value is 4. - value: Stopped description: Indicates the entry point is not running. The value is 5. RestartDeployedCodePackageDescription: description: Defines description for restarting a deployed code package on Service Fabric node. required: - ServiceManifestName - CodePackageName - CodePackageInstanceId properties: ServiceManifestName: $ref: '#/definitions/ServiceManifestName' description: The name of service manifest that specified this code package. ServicePackageActivationId: $ref: '#/definitions/ServicePackageActivationId' description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId is always an empty string.' CodePackageName: $ref: '#/definitions/CodePackageName' description: The name of the code package defined in the service manifest. CodePackageInstanceId: $ref: '#/definitions/CodePackageInstanceId' description: 'The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running. If an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID. Note, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package.' CodePackageEntryPoint: description: Information about setup or main entry point of a code package deployed on a Service Fabric node. properties: EntryPointLocation: type: string description: The location of entry point executable on the node. ProcessId: type: string description: The process ID of the entry point. RunAsUserName: type: string description: The user name under which entry point executable is run on the node. CodePackageEntryPointStatistics: $ref: '#/definitions/CodePackageEntryPointStatistics' description: Statistics about setup or main entry point of a code package deployed on a Service Fabric node. Status: $ref: '#/definitions/EntryPointStatus' description: Specifies the status of the code package entry point deployed on a Service Fabric node. NextActivationTime: type: string format: date-time description: The time (in UTC) when the entry point executable will be run next. InstanceId: $ref: '#/definitions/CodePackageInstanceId' description: The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change. CodePackageName: type: string description: The name of the code package defined in the service manifest. ServiceManifestName: type: string description: The name of the service manifest. ContainerApiResult: description: Container API result. properties: Status: type: integer description: HTTP status code returned by the target container API Content-Type: type: string description: HTTP content type Content-Encoding: type: string description: HTTP content encoding Body: type: string description: container API result body required: - Status DeploymentStatus: type: string description: Specifies the status of a deployed application or service package on a Service Fabric node. enum: - Invalid - Downloading - Activating - Active - Upgrading - Deactivating - RanToCompletion - Failed x-ms-enum: name: DeploymentStatus modelAsString: true values: - value: Invalid description: Indicates status of the application or service package is not known or invalid. The value is 0. - value: Downloading description: Indicates the application or service package is being downloaded to the node from the ImageStore. The value is 1. - value: Activating description: Indicates the application or service package is being activated. The value is 2. - value: Active description: Indicates the application or service package is active the node. The value is 3. - value: Upgrading description: Indicates the application or service package is being upgraded. The value is 4. - value: Deactivating description: Indicates the application or service package is being deactivated. The value is 5. - value: RanToCompletion description: Indicates the application or service package has ran to completion successfully. The value is 6. - value: Failed description: Indicates the application or service package has failed to run to completion. The value is 7. HostType: type: string description: Specifies the type of host for main entry point of a code package as specified in service manifest. enum: - Invalid - ExeHost - ContainerHost x-ms-enum: name: HostType modelAsString: true values: - value: Invalid description: Indicates the type of host is not known or invalid. The value is 0. - value: ExeHost description: Indicates the host is an executable. The value is 1. - value: ContainerHost description: Indicates the host is a container. The value is 2. ContainerLogs: description: Container logs. properties: Content: type: string description: Container logs. 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 CodePackageEntryPointStatistics: description: Statistics about setup or main entry point of a code package deployed on a Service Fabric node. properties: LastExitCode: type: string description: The last exit code of the entry point. LastActivationTime: type: string format: date-time description: The last time (in UTC) when Service Fabric attempted to run the entry point. LastExitTime: type: string format: date-time description: The last time (in UTC) when the entry point finished running. LastSuccessfulActivationTime: type: string format: date-time description: The last time (in UTC) when the entry point ran successfully. LastSuccessfulExitTime: type: string format: date-time description: The last time (in UTC) when the entry point finished running gracefully. ActivationCount: type: string description: Number of times the entry point has run. ActivationFailureCount: type: string description: Number of times the entry point failed to run. ContinuousActivationFailureCount: type: string description: Number of times the entry point continuously failed to run. ExitCount: type: string description: Number of times the entry point finished running. ExitFailureCount: type: string description: Number of times the entry point failed to exit gracefully. ContinuousExitFailureCount: type: string description: Number of times the entry point continuously failed to exit gracefully. 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 CodePackageInstanceId: type: string description: The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change. HostIsolationMode: type: string description: Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest. enum: - None - Process - HyperV x-ms-enum: name: HostIsolationMode modelAsString: true values: - value: None description: Indicates the isolation mode is not applicable for given HostType. The value is 0. - value: Process description: This is the default isolation mode for a ContainerHost. The value is 1. - value: HyperV description: Indicates the ContainerHost is a Hyper-V container. This applies to only Windows containers. The value is 2. DeployedCodePackageInfo: description: Information about code package deployed on a Service Fabric node. properties: Name: $ref: '#/definitions/CodePackageName' description: The name of the code package. Version: type: string description: The version of the code package specified in service manifest. ServiceManifestName: $ref: '#/definitions/ServiceManifestName' description: The name of service manifest that specified this code package. ServicePackageActivationId: $ref: '#/definitions/ServicePackageActivationId' description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId is always an empty string.' HostType: $ref: '#/definitions/HostType' description: Specifies the type of host for main entry point of a code package as specified in service manifest. HostIsolationMode: $ref: '#/definitions/HostIsolationMode' description: Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest. Status: $ref: '#/definitions/DeploymentStatus' description: Specifies the status of a deployed application or service package on a Service Fabric node. RunFrequencyInterval: type: string description: The interval at which code package is run. This is used for periodic code package. SetupEntryPoint: $ref: '#/definitions/CodePackageEntryPoint' description: Information about setup or main entry point of a code package deployed on a Service Fabric node. MainEntryPoint: $ref: '#/definitions/CodePackageEntryPoint' description: Information about setup or main entry point of a code package deployed on a Service Fabric node. parameters: ServiceManifestNameRequiredQueryParam: name: ServiceManifestName in: query x-ms-parameter-location: method type: string required: true description: The name of a service manifest registered as part of an application type in a Service Fabric cluster. CodePackageInstanceIdRequiredQueryParam: name: CodePackageInstanceId description: ID that uniquely identifies a code package instance deployed on a service fabric node. in: query x-ms-parameter-location: method type: string required: true ServiceManifestNameOptionalQueryParam: name: ServiceManifestName in: query x-ms-parameter-location: method type: string required: false description: The name of a service manifest registered as part of an application type in a Service Fabric cluster. PreviousOptionalQueryParam: name: Previous in: query x-ms-parameter-location: method type: boolean description: Specifies whether to get container logs from exited/dead containers of the code package instance. required: false default: false NodeNameRequiredPathParam: name: nodeName in: path x-ms-parameter-location: method type: string required: true description: The name of the node. ContainerApiRequiredBodyParam: name: ContainerApiRequestBody in: body description: Parameters for making container API call required: true x-ms-parameter-location: method schema: $ref: '#/definitions/ContainerApiRequestBody' CodePackageNameOptionalQueryParam: name: CodePackageName in: query x-ms-parameter-location: method type: string required: false description: The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. CodePackageNameRequiredQueryParam: name: CodePackageName in: query x-ms-parameter-location: method type: string required: true description: The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. 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. TailOptionalQueryParam: name: Tail in: query x-ms-parameter-location: method type: string required: false description: Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs. ApiVersion_6-2_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '6.2' required: true default: '6.2' description: 'The version of the API. This parameter is required and its value must be ''6.2''. 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 version 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 accepts 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 and the runtime is 6.1, 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.' x-ms-enum: name: ApiVersion_6-2_RequiredQueryParam modelAsString: true values: - value: '6.2' description: The 6.2 version of the API. ApiVersion_6-0_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '6.0' required: true default: '6.0' description: '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.' x-ms-enum: name: ApiVersion_6-0_RequiredQueryParam modelAsString: true values: - value: '6.0' description: The 6.0 version of the API. RestartDeployedCodePackageRequiredBodyParam: name: RestartDeployedCodePackageDescription in: body description: Describes the deployed code package on Service Fabric node to restart. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/RestartDeployedCodePackageDescription' ApplicationIdRequiredPathParam: name: applicationId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: '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.' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'