{
"opencollection": "1.0.0",
"info": {
"name": "Microsoft Azure AccessControlClient AccessConnector ImageStore API",
"version": "2020-08-01-preview"
},
"items": [
{
"info": {
"name": "ImageStore",
"type": "folder"
},
"items": [
{
"info": {
"name": "Microsoft Azure Gets The Image Store Content Information",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/ImageStore/:contentPath",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "contentPath",
"value": "",
"type": "path",
"description": "Relative path to file or folder in the image store from its root."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Returns the information about the image store content at the specified contentPath. The contentPath is relative to the root of the image store."
},
{
"info": {
"name": "Microsoft Azure Uploads Contents Of The File To The Image Store",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/ImageStore/:contentPath",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "contentPath",
"value": "",
"type": "path",
"description": "Relative path to file or folder in the image store from its root."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Uploads contents of the file to the image store. Use this API if the file is small enough to upload again if the connection fails. The file's data needs to be added to the request body. The contents will be uploaded to the specified path. Image store service uses a mark file to indicate the availability of the folder. The mark file is an empty file named \"_.dir\". The mark file is generated by the image store service when all files in a folder are uploaded. When using File-by-File approach to upl"
},
{
"info": {
"name": "Microsoft Azure Deletes Existing Image Store Content",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/ImageStore/:contentPath",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "contentPath",
"value": "",
"type": "path",
"description": "Relative path to file or folder in the image store from its root."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Deletes existing image store content being found within the given image store relative path. This command can be used to delete uploaded application packages once they are provisioned."
},
{
"info": {
"name": "Microsoft Azure Gets The Content Information At The Root Of The Image Store",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/ImageStore",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Returns the information about the image store content at the root of the image store."
},
{
"info": {
"name": "Microsoft Azure Copies Image Store Content Internally",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/ImageStore/$/Copy",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Copies the image store content from the source image store relative path to the destination image store relative path."
},
{
"info": {
"name": "Microsoft Azure Cancels An Image Store Upload Session",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/ImageStore/$/DeleteUploadSession",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "session-id",
"value": "",
"type": "query",
"description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks."
},
{
"info": {
"name": "Microsoft Azure Commit An Image Store Upload Session",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/ImageStore/$/CommitUploadSession",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "session-id",
"value": "",
"type": "query",
"description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session until the expiration time, which is 30 minutes after the last chunk received. "
},
{
"info": {
"name": "Microsoft Azure Get The Image Store Upload Session By Id",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/ImageStore/$/GetUploadSession",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "session-id",
"value": "",
"type": "query",
"description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. "
},
{
"info": {
"name": "Microsoft Azure Get The Image Store Upload Session By Relative Path",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/ImageStore/:contentPath/$/GetUploadSession",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "contentPath",
"value": "",
"type": "path",
"description": "Relative path to file or folder in the image store from its root."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. "
},
{
"info": {
"name": "Microsoft Azure Uploads A File Chunk To The Image Store Relative Path",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/ImageStore/:contentPath/$/UploadChunk",
"headers": [
{
"name": "Content-Range",
"value": ""
}
],
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "contentPath",
"value": "",
"type": "path",
"description": "Relative path to file or folder in the image store from its root."
},
{
"name": "session-id",
"value": "",
"type": "query",
"description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Uploads a file chunk to the image store with the specified upload session ID and image store relative path. This API allows user to resume the file upload operation. user doesn't have to restart the file upload from scratch whenever there is a network interruption. Use this option if the file size is large.
To perform a resumable file upload, user need to break the file into multiple chunks and upload these chunks to the image store one-by-one. Chunks don't have to be uploaded in order. I"
},
{
"info": {
"name": "Microsoft Azure Get The Folder Size At The Root Of The Image Store",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/ImageStore/$/FolderSize",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.5'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Returns the total size of files at the root and children folders in image store."
},
{
"info": {
"name": "Microsoft Azure Get The Size Of A Folder In Image Store",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/ImageStore/:contentPath/$/FolderSize",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.5'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "contentPath",
"value": "",
"type": "path",
"description": "Relative path to file or folder in the image store from its root."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Gets the total size of file under a image store folder, specified by contentPath. The contentPath is relative to the root of the image store."
},
{
"info": {
"name": "Microsoft Azure Gets The Overall Imagestore Information",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/ImageStore/$/Info",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The version of the API. This parameter is required and its value must be '6.5'.\n\nService 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.\n\nAdditionally 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."
},
{
"name": "timeout",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "Returns information about the primary ImageStore replica, such as disk capacity and available disk space at the node it is on, and several categories of the ImageStore's file system usage."
}
]
}
],
"bundled": true
}