From 692d12a4d80520f4b8b4c59e0338e8103a2a58ab Mon Sep 17 00:00:00 2001 From: Tamer Sherif Date: Mon, 28 Jun 2021 13:23:04 -0700 Subject: [PATCH] Cleaned up Storage Swagger to get validation tools and CI green --- custom-words.txt | 41 + .../preview/2020-10-02/blob.json | 2619 ++-- .../Microsoft.BlobStorage/readme.md | 53 + .../preview/2020-10-02/file.json | 12668 ++++++++-------- .../preview/2020-10-02/readme.md | 28 - .../Microsoft.FileStorage/readme.md | 53 + .../preview/2018-03-28/queue.json | 72 +- .../preview/2018-03-28/readme.md | 27 - .../Microsoft.QueueStorage/readme.md | 53 + .../Microsoft.StorageDataLake/readme.md | 56 + .../stable/2020-06-12/DataLakeStorage.json | 131 +- specification/storage/data-plane/readme.go.md | 36 - specification/storage/data-plane/readme.md | 155 +- .../storage/data-plane/readme.nodejs.md | 14 - .../storage/data-plane/readme.typescript.md | 12 - 15 files changed, 7757 insertions(+), 8261 deletions(-) create mode 100644 specification/storage/data-plane/Microsoft.BlobStorage/readme.md delete mode 100644 specification/storage/data-plane/Microsoft.FileStorage/preview/2020-10-02/readme.md create mode 100644 specification/storage/data-plane/Microsoft.FileStorage/readme.md delete mode 100644 specification/storage/data-plane/Microsoft.QueueStorage/preview/2018-03-28/readme.md create mode 100644 specification/storage/data-plane/Microsoft.QueueStorage/readme.md create mode 100644 specification/storage/data-plane/Microsoft.StorageDataLake/readme.md delete mode 100644 specification/storage/data-plane/readme.go.md delete mode 100644 specification/storage/data-plane/readme.nodejs.md delete mode 100644 specification/storage/data-plane/readme.typescript.md diff --git a/custom-words.txt b/custom-words.txt index 46592c167985..8de887699e4f 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1606,3 +1606,44 @@ Zilla ziplist Zoho zset +userdelegationkey +batchresponse +policyid +ruleid +legalhold +snaptshot +copyid +blockblob +blocklist +pageblob +pagelist +incrementalcopy +appendblob +Snaphot +deletetype +blocklisttype +uncommittedblobs +immutabilitypolicy +deletedwithversions +prevsnapshot +versionid +Contentcrc +filepermission +listhandles +forceclosehandles +rangelist +SDDL +dacl +optionalbody +sharesnapshot +prevsharesnapshot +peekonly +messageid +popreceipt +messagettl +numofmessages +visibilitytimeout +uncommittedblobs +showonly +blockid +ipos diff --git a/specification/storage/data-plane/Microsoft.BlobStorage/preview/2020-10-02/blob.json b/specification/storage/data-plane/Microsoft.BlobStorage/preview/2020-10-02/blob.json index eceff5ebfa5d..4f786977acab 100644 --- a/specification/storage/data-plane/Microsoft.BlobStorage/preview/2020-10-02/blob.json +++ b/specification/storage/data-plane/Microsoft.BlobStorage/preview/2020-10-02/blob.json @@ -18,13 +18,6 @@ } ] }, - "securityDefinitions": { - "blob_shared_key": { - "type": "apiKey", - "name": "Authorization", - "in": "header" - } - }, "schemes": [ "https" ], @@ -150,6 +143,7 @@ "parameters": [ { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -159,6 +153,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -232,6 +227,7 @@ "parameters": [ { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -241,6 +237,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -324,6 +321,7 @@ "parameters": [ { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -400,6 +398,7 @@ "parameters": [ { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -409,6 +408,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -510,6 +510,7 @@ "parameters": [ { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -519,6 +520,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -596,6 +598,7 @@ "parameters": [ { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -678,6 +681,7 @@ "parameters": [ { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -723,7 +727,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -798,7 +801,6 @@ }, "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -989,8 +991,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -1033,7 +1039,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -1078,8 +1083,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -1089,6 +1098,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -1138,7 +1148,6 @@ }, "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -1223,7 +1232,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -1268,8 +1276,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -1279,6 +1291,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -1299,7 +1312,7 @@ { "$ref": "#/parameters/Timeout" }, - { + { "$ref": "#/parameters/ApiVersionParameter" }, { @@ -1353,8 +1366,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -1364,6 +1381,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -1438,8 +1456,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -1449,6 +1471,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -1524,8 +1547,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -1535,6 +1562,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -1580,7 +1608,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -1630,8 +1657,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -1641,6 +1672,7 @@ }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -1699,7 +1731,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -1744,8 +1775,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -1755,6 +1790,7 @@ }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -1813,7 +1849,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -1863,8 +1898,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -1874,6 +1913,7 @@ }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -1932,7 +1972,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -1982,8 +2021,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -1993,6 +2036,7 @@ }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -2054,7 +2098,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -2104,8 +2147,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -2115,6 +2162,7 @@ }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -2221,8 +2269,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -2232,6 +2284,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -2325,8 +2378,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -2336,6 +2393,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -2430,8 +2488,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -2441,6 +2503,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -2450,46 +2513,43 @@ } ] }, - "/{filesystem}/{path}?resource=directory&Create": { - "put": { + "/{containerName}/{blob}": { + "get": { "tags": [ - "directory" - ], - "operationId": "Directory_Create", - "description": "Create a directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", - "consumes": [ - "application/octet-stream" + "blob" ], + "operationId": "Blob_Download", + "description": "The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot.", "parameters": [ { - "$ref": "#/parameters/Timeout" + "$ref": "#/parameters/Snapshot" }, { - "$ref": "#/parameters/DirectoryProperties" + "$ref": "#/parameters/VersionId" }, { - "$ref": "#/parameters/PosixPermissions" + "$ref": "#/parameters/Timeout" }, { - "$ref": "#/parameters/PosixUmask" + "$ref": "#/parameters/Range" }, { - "$ref": "#/parameters/XMsCacheControl" + "$ref": "#/parameters/LeaseIdOptional" }, { - "$ref": "#/parameters/XMsContentType" + "$ref": "#/parameters/GetRangeContentMD5" }, { - "$ref": "#/parameters/XMsContentEncoding" + "$ref": "#/parameters/GetRangeContentCRC64" }, { - "$ref": "#/parameters/XMsContentLanguage" + "$ref": "#/parameters/EncryptionKey" }, { - "$ref": "#/parameters/XMsContentDisposition" + "$ref": "#/parameters/EncryptionKeySha256" }, { - "$ref": "#/parameters/LeaseIdOptional" + "$ref": "#/parameters/EncryptionAlgorithm" }, { "$ref": "#/parameters/IfModifiedSince" @@ -2503,6 +2563,9 @@ { "$ref": "#/parameters/IfNoneMatch" }, + { + "$ref": "#/parameters/IfTags" + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -2511,1005 +2574,101 @@ } ], "responses": { - "201": { - "description": "The file or directory was created.", + "200": { + "description": "Returns the content of the entire blob.", "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "An HTTP entity tag associated with the file or directory." - }, "Last-Modified": { "type": "string", "format": "date-time-rfc1123", - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", + "x-ms-meta": { "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", + "x-ms-or-policy-id": { + "x-ms-client-name": "ObjectReplicationPolicyId", "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." }, - "x-ms-version": { - "x-ms-client-name": "Version", + "x-ms-or": { "type": "string", - "description": "The version of the REST protocol used to process the request." + "x-ms-client-name": "ObjectReplicationRules", + "x-ms-header-collection-prefix": "x-ms-or-", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." }, "Content-Length": { "type": "integer", "format": "int64", - "description": "The size of the resource in bytes." + "description": "The number of bytes present in the response body." }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", + "Content-Type": { "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", + "Content-Range": { "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." - } - }, - "schema": { - "$ref": "#/definitions/DataLakeStorageError" - } - } - } - }, - "parameters": [ - { - "name": "resource", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "directory" - ] - } - ] - }, - "/{filesystem}/{path}?DirectoryRename": { - "put": { - "tags": [ - "directory" - ], - "operationId": "Directory_Rename", - "description": "Rename a directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", - "consumes": [ - "application/octet-stream" - ], - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Continuation" - }, - { - "$ref": "#/parameters/PathRenameMode" - }, - { - "$ref": "#/parameters/FileRenameSource" - }, - { - "$ref": "#/parameters/DirectoryProperties" - }, - { - "$ref": "#/parameters/PosixPermissions" - }, - { - "$ref": "#/parameters/PosixUmask" - }, - { - "$ref": "#/parameters/XMsCacheControl" - }, - { - "$ref": "#/parameters/XMsContentType" - }, - { - "$ref": "#/parameters/XMsContentEncoding" - }, - { - "$ref": "#/parameters/XMsContentLanguage" - }, - { - "$ref": "#/parameters/XMsContentDisposition" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/SourceLeaseId" - }, - { - "$ref": "#/parameters/IfModifiedSince" - }, - { - "$ref": "#/parameters/IfUnmodifiedSince" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" - }, - { - "$ref": "#/parameters/SourceIfModifiedSince" - }, - { - "$ref": "#/parameters/SourceIfUnmodifiedSince" - }, - { - "$ref": "#/parameters/SourceIfMatch" - }, - { - "$ref": "#/parameters/SourceIfNoneMatch" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "201": { - "description": "The directory was renamed.", - "headers": { - "x-ms-continuation": { - "x-ms-client-name": "marker", + "ETag": { "type": "string", - "description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory." + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, - "ETag": { + "Content-MD5": { "type": "string", - "format": "etag", - "description": "An HTTP entity tag associated with the file or directory." + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." }, - "Last-Modified": { + "Content-Encoding": { "type": "string", - "format": "date-time-rfc1123", - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." + "description": "This header returns the value that was specified for the Content-Encoding request header" }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", + "Cache-Control": { "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + "description": "This header is returned if it was previously specified for the blob." }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", + "Content-Disposition": { "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." }, - "x-ms-version": { - "x-ms-client-name": "Version", + "Content-Language": { "type": "string", - "description": "The version of the REST protocol used to process the request." + "description": "This header returns the value that was specified for the Content-Language request header." }, - "Content-Length": { + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", "type": "integer", "format": "int64", - "description": "The size of the resource in bytes." + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" }, - "Date": { + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." - } - }, - "schema": { - "$ref": "#/definitions/DataLakeStorageError" - } - } - } - } - }, - "/{filesystem}/{path}?DirectoryDelete": { - "delete": { - "tags": [ - "directory" - ], - "operationId": "Directory_Delete", - "description": "Deletes the directory", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/RecursiveDirectoryDelete" - }, - { - "$ref": "#/parameters/Continuation" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/IfModifiedSince" - }, - { - "$ref": "#/parameters/IfUnmodifiedSince" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "200": { - "description": "The directory was deleted.", - "headers": { - "x-ms-continuation": { - "x-ms-client-name": "marker", - "type": "string", - "description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory." - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." - } - }, - "schema": { - "$ref": "#/definitions/DataLakeStorageError" - } - } - } - } - }, - "/{filesystem}/{path}?action=setAccessControl&directory": { - "patch": { - "tags": [ - "directory" - ], - "operationId": "Directory_SetAccessControl", - "description": "Set the owner, group, permissions, or access control list for a directory.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/Owner" - }, - { - "$ref": "#/parameters/Group" - }, - { - "$ref": "#/parameters/PosixPermissions" - }, - { - "$ref": "#/parameters/PosixAcl" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" - }, - { - "$ref": "#/parameters/IfModifiedSince" - }, - { - "$ref": "#/parameters/IfUnmodifiedSince" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Set directory access control response.", - "headers": { - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "An HTTP entity tag associated with the file or directory." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." - } - }, - "schema": { - "$ref": "#/definitions/DataLakeStorageError" - } - } - } - }, - "parameters": [ - { - "name": "action", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "setAccessControl" - ] - } - ] - }, - "/{filesystem}/{path}?action=getAccessControl&directory": { - "head": { - "tags": [ - "directory" - ], - "operationId": "Directory_GetAccessControl", - "description": "Get the owner, group, permissions, or access control list for a directory.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Upn" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" - }, - { - "$ref": "#/parameters/IfModifiedSince" - }, - { - "$ref": "#/parameters/IfUnmodifiedSince" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Get directory access control response.", - "headers": { - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "An HTTP entity tag associated with the file or directory." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." - }, - "x-ms-owner": { - "description": "The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", - "type": "string" - }, - "x-ms-group": { - "description": "The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", - "type": "string" - }, - "x-ms-permissions": { - "description": "The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.", - "type": "string" - }, - "x-ms-acl": { - "description": "The POSIX access control list for the file or directory. Included in the response only if the action is \"getAccessControl\" and Hierarchical Namespace is enabled for the account.", - "type": "string" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." - } - }, - "schema": { - "$ref": "#/definitions/DataLakeStorageError" - } - } - } - }, - "parameters": [ - { - "name": "action", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "getAccessControl" - ] - } - ] - }, - "/{containerName}/{blob}": { - "get": { - "tags": [ - "blob" - ], - "operationId": "Blob_Download", - "description": "The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot.", - "parameters": [ - { - "$ref": "#/parameters/Snapshot" - }, - { - "$ref": "#/parameters/VersionId" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Range" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/GetRangeContentMD5" - }, - { - "$ref": "#/parameters/GetRangeContentCRC64" - }, - { - "$ref": "#/parameters/EncryptionKey" - }, - { - "$ref": "#/parameters/EncryptionKeySha256" - }, - { - "$ref": "#/parameters/EncryptionAlgorithm" - }, - { - "$ref": "#/parameters/IfModifiedSince" - }, - { - "$ref": "#/parameters/IfUnmodifiedSince" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" - }, - { - "$ref": "#/parameters/IfTags" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "200": { - "description": "Returns the content of the entire blob.", - "headers": { - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." - }, - "x-ms-meta": { - "type": "string", - "x-ms-client-name": "Metadata", - "x-ms-header-collection-prefix": "x-ms-meta-" - }, - "x-ms-or-policy-id": { - "x-ms-client-name": "ObjectReplicationPolicyId", - "type": "string", - "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." - }, - "x-ms-or": { - "type": "string", - "x-ms-client-name": "ObjectReplicationRules", - "x-ms-header-collection-prefix": "x-ms-or-", - "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." - }, - "Content-Length": { - "type": "integer", - "format": "int64", - "description": "The number of bytes present in the response body." - }, - "Content-Type": { - "type": "string", - "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" - }, - "Content-Range": { - "type": "string", - "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." - }, - "Content-MD5": { - "type": "string", - "format": "byte", - "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." - }, - "Content-Encoding": { - "type": "string", - "description": "This header returns the value that was specified for the Content-Encoding request header" - }, - "Cache-Control": { - "type": "string", - "description": "This header is returned if it was previously specified for the blob." - }, - "Content-Disposition": { - "type": "string", - "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." - }, - "Content-Language": { - "type": "string", - "description": "This header returns the value that was specified for the Content-Language request header." - }, - "x-ms-blob-sequence-number": { - "x-ms-client-name": "BlobSequenceNumber", - "type": "integer", - "format": "int64", - "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" - }, - "x-ms-blob-type": { - "x-ms-client-name": "BlobType", - "description": "The blob's type.", - "type": "string", - "enum": [ - "BlockBlob", - "PageBlob", - "AppendBlob" - ], - "x-ms-enum": { - "name": "BlobType", - "modelAsString": false - } - }, - "x-ms-copy-completion-time": { - "x-ms-client-name": "CopyCompletionTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." - }, - "x-ms-copy-status-description": { - "x-ms-client-name": "CopyStatusDescription", - "type": "string", - "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" - }, - "x-ms-copy-id": { - "x-ms-client-name": "CopyId", - "type": "string", - "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." - }, - "x-ms-copy-progress": { - "x-ms-client-name": "CopyProgress", - "type": "string", - "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" - }, - "x-ms-copy-source": { - "x-ms-client-name": "CopySource", - "type": "string", - "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." - }, - "x-ms-copy-status": { - "x-ms-client-name": "CopyStatus", - "description": "State of the copy operation identified by x-ms-copy-id.", - "type": "string", - "enum": [ - "pending", - "success", - "aborted", - "failed" - ], - "x-ms-enum": { - "name": "CopyStatusType", - "modelAsString": false - } - }, - "x-ms-lease-duration": { - "x-ms-client-name": "LeaseDuration", - "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", - "type": "string", - "enum": [ - "infinite", - "fixed" - ], - "x-ms-enum": { - "name": "LeaseDurationType", - "modelAsString": false - } - }, - "x-ms-lease-state": { - "x-ms-client-name": "LeaseState", - "description": "Lease state of the blob.", - "type": "string", - "enum": [ - "available", - "leased", - "expired", - "breaking", - "broken" - ], - "x-ms-enum": { - "name": "LeaseStateType", - "modelAsString": false - } - }, - "x-ms-lease-status": { - "x-ms-client-name": "LeaseStatus", - "description": "The current lease status of the blob.", - "type": "string", - "enum": [ - "locked", - "unlocked" - ], - "x-ms-enum": { - "name": "LeaseStatusType", - "modelAsString": false - } - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "x-ms-version-id": { - "x-ms-client-name": "VersionId", - "type": "string", - "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." - }, - "x-ms-is-current-version": { - "x-ms-client-name": "IsCurrentVersion", - "type": "boolean", - "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." - }, - "Accept-Ranges": { - "type": "string", - "description": "Indicates that the service supports requests for partial blob content." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-blob-committed-block-count": { - "x-ms-client-name": "BlobCommittedBlockCount", - "type": "integer", - "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." - }, - "x-ms-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." - }, - "x-ms-encryption-key-sha256": { - "x-ms-client-name": "EncryptionKeySha256", - "type": "string", - "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." - }, - "x-ms-encryption-scope": { - "x-ms-client-name": "EncryptionScope", - "type": "string", - "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." - }, - "x-ms-blob-content-md5": { - "x-ms-client-name": "BlobContentMD5", - "type": "string", - "format": "byte", - "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" - }, - "x-ms-tag-count": { - "x-ms-client-name": "TagCount", - "type": "integer", - "format": "int64", - "description": "The number of tags associated with the blob" - }, - "x-ms-blob-sealed": { - "x-ms-client-name": "IsSealed", - "type": "boolean", - "description": "If this blob has been sealed" - }, - "x-ms-last-access-time": { - "x-ms-client-name": "LastAccessed", - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the blob was last read or written to" - }, - "x-ms-immutability-policy-until-date": { - "x-ms-client-name": "ImmutabilityPolicyExpiresOn", - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire." - }, - "x-ms-immutability-policy-mode": { - "x-ms-client-name": "ImmutabilityPolicyMode", - "type": "string", - "enum": [ - "Mutable", - "Unlocked", - "Locked" - ], - "x-ms-enum": { - "name": "BlobImmutabilityPolicyMode", - "modelAsString": false - }, - "description": "Indicates immutability policy mode." - }, - "x-ms-legal-hold": { - "x-ms-client-name": "LegalHold", - "type": "boolean", - "description": "Indicates if a legal hold is present on the blob." - } - }, - "schema": { - "type": "object", - "format": "file" - } - }, - "206": { - "description": "Returns the content of a specified range of the blob.", - "headers": { - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." - }, - "x-ms-meta": { - "type": "string", - "x-ms-client-name": "Metadata", - "x-ms-header-collection-prefix": "x-ms-meta-" - }, - "x-ms-or-policy-id": { - "x-ms-client-name": "ObjectReplicationPolicyId", - "type": "string", - "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." - }, - "x-ms-or": { - "type": "string", - "x-ms-client-name": "ObjectReplicationRules", - "x-ms-header-collection-prefix": "x-ms-or-", - "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." - }, - "Content-Length": { - "type": "integer", - "format": "int64", - "description": "The number of bytes present in the response body." - }, - "Content-Type": { - "type": "string", - "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" - }, - "Content-Range": { - "type": "string", - "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." - }, - "Content-MD5": { - "type": "string", - "format": "byte", - "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." - }, - "Content-Encoding": { - "type": "string", - "description": "This header returns the value that was specified for the Content-Encoding request header" - }, - "Cache-Control": { - "type": "string", - "description": "This header is returned if it was previously specified for the blob." - }, - "Content-Disposition": { - "type": "string", - "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." - }, - "Content-Language": { - "type": "string", - "description": "This header returns the value that was specified for the Content-Language request header." - }, - "x-ms-blob-sequence-number": { - "x-ms-client-name": "BlobSequenceNumber", - "type": "integer", - "format": "int64", - "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" - }, - "x-ms-blob-type": { - "x-ms-client-name": "BlobType", - "description": "The blob's type.", - "type": "string", - "enum": [ - "BlockBlob", - "PageBlob", - "AppendBlob" - ], - "x-ms-enum": { - "name": "BlobType", - "modelAsString": false - } - }, - "x-ms-content-crc64": { - "x-ms-client-name": "ContentCrc64", - "type": "string", - "format": "byte", - "description": "If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)" - }, - "x-ms-copy-completion-time": { - "x-ms-client-name": "CopyCompletionTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." - }, - "x-ms-copy-status-description": { - "x-ms-client-name": "CopyStatusDescription", - "type": "string", - "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" - }, - "x-ms-copy-id": { - "x-ms-client-name": "CopyId", + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", "type": "string", "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." }, @@ -3666,6 +2825,15 @@ "x-ms-immutability-policy-mode": { "x-ms-client-name": "ImmutabilityPolicyMode", "type": "string", + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, "description": "Indicates immutability policy mode." }, "x-ms-legal-hold": { @@ -3679,100 +2847,73 @@ "format": "file" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "head": { - "tags": [ - "blob" - ], - "operationId": "Blob_GetProperties", - "description": "The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.", - "parameters": [ - { - "$ref": "#/parameters/Snapshot" - }, - { - "$ref": "#/parameters/VersionId" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/EncryptionKey" - }, - { - "$ref": "#/parameters/EncryptionKeySha256" - }, - { - "$ref": "#/parameters/EncryptionAlgorithm" - }, - { - "$ref": "#/parameters/IfModifiedSince" - }, - { - "$ref": "#/parameters/IfUnmodifiedSince" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" - }, - { - "$ref": "#/parameters/IfTags" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "200": { - "description": "Returns the properties of the blob.", + "206": { + "description": "Returns the content of a specified range of the blob.", "headers": { "Last-Modified": { "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-or-policy-id": { + "x-ms-client-name": "ObjectReplicationPolicyId", + "type": "string", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "x-ms-or": { + "type": "string", + "x-ms-client-name": "ObjectReplicationRules", + "x-ms-header-collection-prefix": "x-ms-or-", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, - "x-ms-creation-time": { - "x-ms-client-name": "CreationTime", + "Content-MD5": { "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the blob was created." + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." }, - "x-ms-meta": { + "Content-Encoding": { "type": "string", - "x-ms-client-name": "Metadata", - "x-ms-header-collection-prefix": "x-ms-meta-" + "description": "This header returns the value that was specified for the Content-Encoding request header" }, - "x-ms-or-policy-id": { - "x-ms-client-name": "ObjectReplicationPolicyId", + "Cache-Control": { "type": "string", - "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + "description": "This header is returned if it was previously specified for the blob." }, - "x-ms-or": { + "Content-Disposition": { "type": "string", - "x-ms-client-name": "ObjectReplicationRules", - "x-ms-header-collection-prefix": "x-ms-or-", - "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" }, "x-ms-blob-type": { "x-ms-client-name": "BlobType", @@ -3788,6 +2929,12 @@ "modelAsString": false } }, + "x-ms-content-crc64": { + "x-ms-client-name": "ContentCrc64", + "type": "string", + "format": "byte", + "description": "If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)" + }, "x-ms-copy-completion-time": { "x-ms-client-name": "CopyCompletionTime", "type": "string", @@ -3829,16 +2976,6 @@ "modelAsString": false } }, - "x-ms-incremental-copy": { - "x-ms-client-name": "IsIncrementalCopy", - "type": "boolean", - "description": "Included if the blob is incremental copy blob." - }, - "x-ms-copy-destination-snapshot": { - "x-ms-client-name": "DestinationSnapshot", - "type": "string", - "description": "Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob." - }, "x-ms-lease-duration": { "x-ms-client-name": "LeaseDuration", "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", @@ -3881,47 +3018,6 @@ "modelAsString": false } }, - "Content-Length": { - "type": "integer", - "format": "int64", - "description": "The number of bytes present in the response body." - }, - "Content-Type": { - "type": "string", - "description": "The content type specified for the blob. The default content type is 'application/octet-stream'" - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." - }, - "Content-MD5": { - "type": "string", - "format": "byte", - "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." - }, - "Content-Encoding": { - "type": "string", - "description": "This header returns the value that was specified for the Content-Encoding request header" - }, - "Content-Disposition": { - "type": "string", - "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." - }, - "Content-Language": { - "type": "string", - "description": "This header returns the value that was specified for the Content-Language request header." - }, - "Cache-Control": { - "type": "string", - "description": "This header is returned if it was previously specified for the blob." - }, - "x-ms-blob-sequence-number": { - "x-ms-client-name": "BlobSequenceNumber", - "type": "integer", - "format": "int64", - "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" - }, "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", "type": "string", @@ -3937,15 +3033,25 @@ "type": "string", "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, - "Date": { + "x-ms-version-id": { + "x-ms-client-name": "VersionId", "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "x-ms-is-current-version": { + "x-ms-client-name": "IsCurrentVersion", + "type": "boolean", + "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." }, "Accept-Ranges": { "type": "string", "description": "Indicates that the service supports requests for partial blob content." }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, "x-ms-blob-committed-block-count": { "x-ms-client-name": "BlobCommittedBlockCount", "type": "integer", @@ -3959,43 +3065,18 @@ "x-ms-encryption-key-sha256": { "x-ms-client-name": "EncryptionKeySha256", "type": "string", - "description": "The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key." + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." }, "x-ms-encryption-scope": { "x-ms-client-name": "EncryptionScope", "type": "string", "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." }, - "x-ms-access-tier": { - "x-ms-client-name": "AccessTier", - "type": "string", - "description": "The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob storage LRS accounts, valid values are Hot/Cool/Archive." - }, - "x-ms-access-tier-inferred": { - "x-ms-client-name": "AccessTierInferred", - "type": "boolean", - "description": "For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value." - }, - "x-ms-archive-status": { - "x-ms-client-name": "ArchiveStatus", - "type": "string", - "description": "For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier." - }, - "x-ms-access-tier-change-time": { - "x-ms-client-name": "AccessTierChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set." - }, - "x-ms-version-id": { - "x-ms-client-name": "VersionId", + "x-ms-blob-content-md5": { + "x-ms-client-name": "BlobContentMD5", "type": "string", - "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." - }, - "x-ms-is-current-version": { - "x-ms-client-name": "IsCurrentVersion", - "type": "boolean", - "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." + "format": "byte", + "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" }, "x-ms-tag-count": { "x-ms-client-name": "TagCount", @@ -4003,22 +3084,11 @@ "format": "int64", "description": "The number of tags associated with the blob" }, - "x-ms-expiry-time": { - "x-ms-client-name": "ExpiresOn", - "type": "string", - "format": "date-time-rfc1123", - "description": "The time this blob will expire." - }, "x-ms-blob-sealed": { "x-ms-client-name": "IsSealed", "type": "boolean", "description": "If this blob has been sealed" }, - "x-ms-rehydrate-priority": { - "x-ms-client-name": "RehydratePriority", - "description": "If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard.", - "type": "string" - }, "x-ms-last-access-time": { "x-ms-client-name": "LastAccessed", "type": "string", @@ -4031,112 +3101,20 @@ "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire." }, - "x-ms-immutability-policy-mode": { - "x-ms-client-name": "ImmutabilityPolicyMode", - "type": "string", - "enum": [ - "Mutable", - "Unlocked", - "Locked" - ], - "x-ms-enum": { - "name": "BlobImmutabilityPolicyMode", - "modelAsString": false - }, - "description": "Indicates immutability policy mode." - }, - "x-ms-legal-hold": { - "x-ms-client-name": "LegalHold", - "type": "boolean", - "description": "Indicates if a legal hold is present on the blob." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "delete": { - "tags": [ - "blob" - ], - "operationId": "Blob_Delete", - "description": "If the storage account's soft delete feature is disabled then, when a blob is deleted, it is permanently removed from the storage account. If the storage account's soft delete feature is enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible immediately. However, the blob service retains the blob or snapshot for the number of days specified by the DeleteRetentionPolicy section of [Storage service properties] (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is permanently removed from the storage account. Note that you continue to be charged for the soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the \"include=deleted\" query parameter to discover which blobs and snapshots have been soft deleted. You can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a soft-deleted blob or snapshot causes the service to return an HTTP status code of 404 (ResourceNotFound).", - "parameters": [ - { - "$ref": "#/parameters/Snapshot" - }, - { - "$ref": "#/parameters/VersionId" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/DeleteSnapshots" - }, - { - "$ref": "#/parameters/IfModifiedSince" - }, - { - "$ref": "#/parameters/IfUnmodifiedSince" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" - }, - { - "$ref": "#/parameters/IfTags" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/BlobDeleteType" - } - ], - "responses": { - "202": { - "description": "The delete request was accepted and the blob will be deleted.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "Indicates immutability policy mode." + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if a legal hold is present on the blob." } + }, + "schema": { + "type": "object", + "format": "file" } }, "default": { @@ -4152,16 +3130,20 @@ } } } - } - }, - "/{filesystem}/{path}?action=setAccessControl&blob": { - "patch": { + }, + "head": { "tags": [ "blob" ], - "operationId": "Blob_SetAccessControl", - "description": "Set the owner, group, permissions, or access control list for a blob.", + "operationId": "Blob_GetProperties", + "description": "The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.", "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, { "$ref": "#/parameters/Timeout" }, @@ -4169,16 +3151,19 @@ "$ref": "#/parameters/LeaseIdOptional" }, { - "$ref": "#/parameters/Owner" + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" }, { - "$ref": "#/parameters/Group" + "$ref": "#/parameters/EncryptionAlgorithm" }, { - "$ref": "#/parameters/PosixPermissions" + "$ref": "#/parameters/IfModifiedSince" }, { - "$ref": "#/parameters/PosixAcl" + "$ref": "#/parameters/IfUnmodifiedSince" }, { "$ref": "#/parameters/IfMatch" @@ -4187,52 +3172,193 @@ "$ref": "#/parameters/IfNoneMatch" }, { - "$ref": "#/parameters/IfModifiedSince" + "$ref": "#/parameters/IfTags" }, { - "$ref": "#/parameters/IfUnmodifiedSince" + "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Set blob access control response.", + "description": "Returns the properties of the blob.", "headers": { - "Date": { + "Last-Modified": { "type": "string", "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." }, - "ETag": { + "x-ms-creation-time": { + "x-ms-client-name": "CreationTime", "type": "string", - "format": "etag", - "description": "An HTTP entity tag associated with the file or directory." + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was created." }, - "Last-Modified": { + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-or-policy-id": { + "x-ms-client-name": "ObjectReplicationPolicyId", + "type": "string", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "x-ms-or": { + "type": "string", + "x-ms-client-name": "ObjectReplicationRules", + "x-ms-header-collection-prefix": "x-ms-or-", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", "type": "string", "format": "date-time-rfc1123", - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" }, - "x-ms-version": { - "x-ms-client-name": "Version", + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", "type": "string", - "description": "The version of the REST protocol used to process the request." - } - } - }, - "default": { - "description": "Failure", - "headers": { + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-incremental-copy": { + "x-ms-client-name": "IsIncrementalCopy", + "type": "boolean", + "description": "Included if the blob is incremental copy blob." + }, + "x-ms-copy-destination-snapshot": { + "x-ms-client-name": "DestinationSnapshot", + "type": "string", + "description": "Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the blob. The default content type is 'application/octet-stream'" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", "type": "string", @@ -4241,201 +3367,163 @@ "x-ms-request-id": { "x-ms-client-name": "RequestId", "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-access-tier": { + "x-ms-client-name": "AccessTier", + "type": "string", + "description": "The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob storage LRS accounts, valid values are Hot/Cool/Archive." }, - "x-ms-version": { - "x-ms-client-name": "Version", + "x-ms-access-tier-inferred": { + "x-ms-client-name": "AccessTierInferred", + "type": "boolean", + "description": "For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value." + }, + "x-ms-archive-status": { + "x-ms-client-name": "ArchiveStatus", "type": "string", - "description": "The version of the REST protocol used to process the request." - } - }, - "schema": { - "$ref": "#/definitions/DataLakeStorageError" - } - } - } - }, - "parameters": [ - { - "name": "action", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "setAccessControl" - ] - } - ] - }, - "/{filesystem}/{path}?action=getAccessControl&blob": { - "head": { - "tags": [ - "blob" - ], - "operationId": "Blob_GetAccessControl", - "description": "Get the owner, group, permissions, or access control list for a blob.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Upn" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" - }, - { - "$ref": "#/parameters/IfModifiedSince" - }, - { - "$ref": "#/parameters/IfUnmodifiedSince" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Get blob access control response.", - "headers": { - "Date": { + "description": "For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier." + }, + "x-ms-access-tier-change-time": { + "x-ms-client-name": "AccessTierChangeTime", "type": "string", "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + "description": "The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set." }, - "ETag": { + "x-ms-version-id": { + "x-ms-client-name": "VersionId", "type": "string", - "format": "etag", - "description": "An HTTP entity tag associated with the file or directory." + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." }, - "Last-Modified": { + "x-ms-is-current-version": { + "x-ms-client-name": "IsCurrentVersion", + "type": "boolean", + "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." + }, + "x-ms-tag-count": { + "x-ms-client-name": "TagCount", + "type": "integer", + "format": "int64", + "description": "The number of tags associated with the blob" + }, + "x-ms-expiry-time": { + "x-ms-client-name": "ExpiresOn", "type": "string", "format": "date-time-rfc1123", - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." - }, - "x-ms-owner": { - "description": "The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", - "type": "string" + "description": "The time this blob will expire." }, - "x-ms-group": { - "description": "The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", - "type": "string" + "x-ms-blob-sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean", + "description": "If this blob has been sealed" }, - "x-ms-permissions": { - "description": "The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.", + "x-ms-rehydrate-priority": { + "x-ms-client-name": "RehydratePriority", + "description": "If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard.", "type": "string" }, - "x-ms-acl": { - "description": "The POSIX access control list for the file or directory. Included in the response only if the action is \"getAccessControl\" and Hierarchical Namespace is enabled for the account.", - "type": "string" + "x-ms-last-access-time": { + "x-ms-client-name": "LastAccessed", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob was last read or written to" }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", + "x-ms-immutability-policy-until-date": { + "x-ms-client-name": "ImmutabilityPolicyExpiresOn", "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire." }, - "x-ms-version": { - "x-ms-client-name": "Version", + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", "type": "string", - "description": "The version of the REST protocol used to process the request." + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, + "description": "Indicates immutability policy mode." + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if a legal hold is present on the blob." } } }, "default": { "description": "Failure", "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, "schema": { - "$ref": "#/definitions/DataLakeStorageError" + "$ref": "#/definitions/StorageError" } } } }, - "parameters": [ - { - "name": "action", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "getAccessControl" - ] - } - ] - }, - "/{filesystem}/{path}?FileRename": { - "put": { + "delete": { "tags": [ "blob" ], - "operationId": "Blob_Rename", - "description": "Rename a blob/file. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", - "consumes": [ - "application/octet-stream" - ], + "operationId": "Blob_Delete", + "description": "If the storage account's soft delete feature is disabled then, when a blob is deleted, it is permanently removed from the storage account. If the storage account's soft delete feature is enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible immediately. However, the blob service retains the blob or snapshot for the number of days specified by the DeleteRetentionPolicy section of [Storage service properties] (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is permanently removed from the storage account. Note that you continue to be charged for the soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the \"include=deleted\" query parameter to discover which blobs and snapshots have been soft deleted. You can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a soft-deleted blob or snapshot causes the service to return an HTTP status code of 404 (ResourceNotFound).", "parameters": [ { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/PathRenameMode" - }, - { - "$ref": "#/parameters/FileRenameSource" - }, - { - "$ref": "#/parameters/DirectoryProperties" - }, - { - "$ref": "#/parameters/PosixPermissions" - }, - { - "$ref": "#/parameters/PosixUmask" - }, - { - "$ref": "#/parameters/XMsCacheControl" - }, - { - "$ref": "#/parameters/XMsContentType" - }, - { - "$ref": "#/parameters/XMsContentEncoding" + "$ref": "#/parameters/Snapshot" }, { - "$ref": "#/parameters/XMsContentLanguage" + "$ref": "#/parameters/VersionId" }, { - "$ref": "#/parameters/XMsContentDisposition" + "$ref": "#/parameters/Timeout" }, { "$ref": "#/parameters/LeaseIdOptional" }, { - "$ref": "#/parameters/SourceLeaseId" + "$ref": "#/parameters/DeleteSnapshots" }, { "$ref": "#/parameters/IfModifiedSince" @@ -4450,38 +3538,22 @@ "$ref": "#/parameters/IfNoneMatch" }, { - "$ref": "#/parameters/SourceIfModifiedSince" - }, - { - "$ref": "#/parameters/SourceIfUnmodifiedSince" - }, - { - "$ref": "#/parameters/SourceIfMatch" - }, - { - "$ref": "#/parameters/SourceIfNoneMatch" + "$ref": "#/parameters/IfTags" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobDeleteType" } ], "responses": { - "201": { - "description": "The file was renamed.", + "202": { + "description": "The delete request was accepted and the blob will be deleted.", "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "An HTTP entity tag associated with the file or directory." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." - }, "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", "type": "string", @@ -4490,50 +3562,42 @@ "x-ms-request-id": { "x-ms-client-name": "RequestId", "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." }, "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "The version of the REST protocol used to process the request." - }, - "Content-Length": { - "type": "integer", - "format": "int64", - "description": "The size of the resource in bytes." + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } } }, "default": { "description": "Failure", "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, "schema": { - "$ref": "#/definitions/DataLakeStorageError" + "$ref": "#/definitions/StorageError" } } } - } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + } + ] }, "/{containerName}/{blob}?PageBlob": { "put": { @@ -4637,7 +3701,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -4707,6 +3770,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "x-ms-blob-type", "x-ms-client-name": "blobType", @@ -4818,7 +3887,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -4888,6 +3956,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "x-ms-blob-type", "x-ms-client-name": "blobType", @@ -5008,7 +4082,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -5078,6 +4151,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "x-ms-blob-type", "x-ms-client-name": "blobType", @@ -5213,7 +4292,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -5283,6 +4361,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "x-ms-blob-type", "x-ms-client-name": "blobType", @@ -5360,8 +4444,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -5401,7 +4492,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -5446,8 +4536,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -5517,7 +4614,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -5568,8 +4664,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -5724,8 +4827,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -5802,8 +4912,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -5870,7 +4987,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -5935,8 +5051,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -5991,7 +5114,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -6002,7 +5124,7 @@ "x-ms-lease-id": { "x-ms-client-name": "LeaseId", "type": "string", - "description": "Uniquely identifies a blobs's lease" + "description": "Uniquely identifies a blobs' lease" }, "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -6041,8 +5163,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -6110,7 +5239,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -6155,8 +5283,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -6224,7 +5359,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -6235,7 +5369,7 @@ "x-ms-lease-id": { "x-ms-client-name": "LeaseId", "type": "string", - "description": "Uniquely identifies a blobs's lease" + "description": "Uniquely identifies a blobs' lease" }, "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -6274,8 +5408,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -6346,7 +5487,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -6367,7 +5507,7 @@ "x-ms-lease-id": { "x-ms-client-name": "LeaseId", "type": "string", - "description": "Uniquely identifies a blobs's lease" + "description": "Uniquely identifies a blobs' lease" }, "x-ms-version": { "x-ms-client-name": "Version", @@ -6396,8 +5536,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -6465,7 +5612,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -6515,8 +5661,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -6604,7 +5757,6 @@ }, "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -6659,8 +5811,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -6754,7 +5913,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -6823,7 +5981,14 @@ } } }, - "parameters": [] + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + } + ] }, "/{containerName}/{blob}?comp=copy&sync": { "put": { @@ -6906,7 +6071,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -6983,8 +6147,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "x-ms-requires-sync", + "description": "This header indicates that this is a synchronous Copy Blob From URL instead of a Asynchronous Copy Blob.", "in": "header", "required": true, "type": "string", @@ -6994,7 +6165,7 @@ } ] }, - "/{containerName}/{blob}?comp=copy©id={CopyId}": { + "/{containerName}/{blob}?comp=copy©id": { "put": { "tags": [ "blob" @@ -7059,8 +6230,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -7070,6 +6248,7 @@ }, { "name": "x-ms-copy-action", + "description": "Copy action.", "x-ms-client-name": "copyActionAbortConstant", "in": "header", "required": true, @@ -7173,8 +6352,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -7269,8 +6455,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -7280,6 +6473,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -7406,8 +6600,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -7461,7 +6662,7 @@ { "$ref": "#/parameters/LeaseIdOptional" }, - { + { "$ref": "#/parameters/SourceIfModifiedSince" }, { @@ -7549,8 +6750,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -7633,6 +6841,7 @@ }, { "name": "blocks", + "description": "Blob Blocks.", "in": "body", "required": true, "schema": { @@ -7664,7 +6873,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -7778,7 +6986,6 @@ }, "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Content-Type": { @@ -7831,8 +7038,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -7923,7 +7137,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -7999,8 +7212,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -8098,7 +7318,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -8159,8 +7378,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -8285,7 +7511,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -8356,8 +7581,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -8436,7 +7668,6 @@ }, "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "x-ms-blob-content-length": { @@ -8485,8 +7716,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -8555,7 +7793,6 @@ }, "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "x-ms-blob-content-length": { @@ -8604,8 +7841,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -8672,7 +7916,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -8723,8 +7966,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -8782,7 +8032,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -8833,8 +8082,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -8886,7 +8142,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -8951,8 +8206,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -9037,7 +8299,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -9117,8 +8378,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -9221,7 +8489,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -9296,8 +8563,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -9349,7 +8623,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -9399,8 +8672,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -9490,7 +8770,6 @@ }, "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Content-MD5": { @@ -9701,7 +8980,6 @@ }, "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Content-MD5": { @@ -9905,8 +9183,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -9981,7 +9266,7 @@ "x-ms-error-code": { "x-ms-client-name": "ErrorCode", "type": "string" - } + } }, "schema": { "$ref": "#/definitions/StorageError" @@ -10065,8 +9350,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -10209,25 +9501,6 @@ } } }, - "DataLakeStorageError": { - "type": "object", - "properties": { - "error": { - "x-ms-client-name": "DataLakeStorageErrorDetails", - "description": "The service error response object.", - "properties": { - "Code": { - "description": "The service error code.", - "type": "string" - }, - "Message": { - "description": "The service error message.", - "type": "string" - } - } - } - } - }, "AccessPolicy": { "type": "object", "description": "An Access policy", @@ -10347,8 +9620,7 @@ "format": "date-time-rfc1123" }, "Etag": { - "type": "string", - "format": "etag" + "type": "string" }, "Content-Length": { "type": "integer", @@ -10488,12 +9760,11 @@ "Locked" ], "x-ms-enum": { - "name": "BlobImmutabilityPolicyMode", - "modelAsString": false + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false } }, "LegalHold": { - "x-ms-client-name": "LegalHold", "type": "boolean" } } @@ -10792,8 +10063,7 @@ "format": "date-time-rfc1123" }, "Etag": { - "type": "string", - "format": "etag" + "type": "string" }, "LeaseStatus": { "$ref": "#/definitions/LeaseStatus" @@ -10894,7 +10164,7 @@ } } }, - "ArrowConfiguration" : { + "ArrowConfiguration": { "xml": { "name": "ArrowConfiguration" }, @@ -11154,7 +10424,7 @@ "required": [ "Name", "ContainerName", - "TagValue" + "Tags" ], "properties": { "Name": { @@ -11437,7 +10707,7 @@ "QueryFormat": { "type": "object", "required": [ - "QueryType" + "Type" ], "properties": { "Type": { @@ -11630,6 +10900,7 @@ "Url": { "name": "url", "description": "The URL of the service account, container, or blob that is the target of the desired operation.", + "x-ms-parameter-location": "client", "required": true, "type": "string", "in": "path", @@ -11637,6 +10908,7 @@ }, "ApiVersionParameter": { "name": "x-ms-version", + "x-ms-parameter-location": "client", "x-ms-client-name": "version", "in": "header", "required": true, @@ -11657,22 +10929,6 @@ "x-ms-parameter-location": "method", "description": "The blob name." }, - "Filesystem": { - "name": "filesystem", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The filesystem name." - }, - "Path": { - "name": "path", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The namespace path to a file or directory." - }, "BlobCacheControl": { "name": "x-ms-blob-cache-control", "x-ms-client-name": "blobCacheControl", @@ -11728,7 +10984,7 @@ "modelAsString": true } }, - "BlobTagsBody" : { + "BlobTagsBody": { "name": "Tags", "in": "body", "schema": { @@ -12022,15 +11278,6 @@ "x-ms-parameter-location": "method", "description": "Initial data" }, - "Continuation": { - "name": "continuation", - "x-ms-client-name": "marker", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory." - }, "ContainerAcl": { "name": "containerAcl", "in": "body", @@ -12101,7 +11348,6 @@ "in": "header", "required": true, "type": "string", - "format": "url", "x-ms-parameter-location": "method", "description": "Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature." }, @@ -12148,15 +11394,6 @@ "in": "query", "required": true }, - "DirectoryProperties": { - "name": "x-ms-properties", - "description": "Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", - "x-ms-client-name": "directoryProperties", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, "EncryptionKey": { "name": "x-ms-encryption-key", "x-ms-client-name": "encryptionKey", @@ -12254,15 +11491,6 @@ }, "description": "Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a different encryption scope than the scope set on the container." }, - "FileRenameSource": { - "name": "x-ms-rename-source", - "x-ms-client-name": "renameSource", - "in": "header", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The file or directory to be renamed. The value must have the following format: \"/{filesysystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved." - }, "FilterBlobsWhere": { "name": "where", "in": "query", @@ -12295,7 +11523,6 @@ "in": "header", "required": false, "type": "string", - "format": "etag", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "modified-access-conditions" @@ -12321,7 +11548,6 @@ "in": "header", "required": false, "type": "string", - "format": "etag", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "modified-access-conditions" @@ -12420,6 +11646,7 @@ "description": "Specifies the immutability policy mode to set on the blob." }, "KeyInfo": { + "description": "Key information", "name": "KeyInfo", "in": "body", "x-ms-parameter-location": "method", @@ -12463,7 +11690,7 @@ "type": "array", "collectionFormat": "csv", "items": { - "type" : "string", + "type": "string", "enum": [ "metadata", "deleted" @@ -12533,33 +11760,6 @@ "x-ms-parameter-location": "method", "description": "Specified if a legal hold should be set on the blob." }, - "Owner": { - "name": "x-ms-owner", - "x-ms-client-name": "owner", - "in": "header", - "required": false, - "type": "string", - "description": "Optional. The owner of the blob or directory.", - "x-ms-parameter-location": "method" - }, - "Group": { - "name": "x-ms-group", - "x-ms-client-name": "group", - "in": "header", - "required": false, - "type": "string", - "description": "Optional. The owning group of the blob or directory.", - "x-ms-parameter-location": "method" - }, - "Upn": { - "name": "upn", - "x-ms-client-name": "upn", - "in": "query", - "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false.", - "required": false, - "type": "boolean", - "x-ms-parameter-location": "method" - }, "Marker": { "name": "marker", "in": "query", @@ -12615,49 +11815,6 @@ "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed).", "x-ms-header-collection-prefix": "x-ms-or-" }, - "PathRenameMode": { - "name": "mode", - "x-ms-client-name": "pathRenameMode", - "description": "Determines the behavior of the rename operation", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "legacy", - "posix" - ], - "x-ms-enum": { - "name": "PathRenameMode", - "modelAsString": false - } - }, - "PosixPermissions": { - "name": "x-ms-permissions", - "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", - "x-ms-client-name": "posixPermissions", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "PosixAcl": { - "name": "x-ms-acl", - "description": "Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\".", - "x-ms-client-name": "posixAcl", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "PosixUmask": { - "name": "x-ms-umask", - "x-ms-client-name": "posixUmask", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used." - }, "Prefix": { "name": "prefix", "in": "query", @@ -12680,7 +11837,6 @@ "in": "header", "required": false, "type": "string", - "format": "url", "x-ms-parameter-location": "method", "description": "Optional. This header is only supported in service versions 2019-04-19 and after and specifies the URL of a previous snapshot of the target blob. The response will only contain pages that were changed between the target blob and its previous snapshot." }, @@ -12705,6 +11861,7 @@ "QueryRequest": { "name": "queryRequest", "in": "body", + "x-ms-parameter-location": "client", "schema": { "$ref": "#/definitions/QueryRequest" }, @@ -12728,15 +11885,6 @@ "x-ms-parameter-location": "method", "description": "The range of bytes to which the source range would be written. The range should be 512 aligned and range-end is required." }, - "RecursiveDirectoryDelete": { - "name": "recursive", - "x-ms-client-name": "recursiveDirectoryDelete", - "in": "query", - "required": true, - "type": "boolean", - "x-ms-parameter-location": "method", - "description": "If \"true\", all paths beneath the directory will be deleted. If \"false\" and the directory is non-empty, an error occurs." - }, "SequenceNumberAction": { "name": "x-ms-sequence-number-action", "x-ms-client-name": "sequenceNumberAction", @@ -12834,7 +11982,6 @@ "in": "header", "required": false, "type": "string", - "format": "etag", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "source-modified-access-conditions" @@ -12860,7 +12007,6 @@ "in": "header", "required": false, "type": "string", - "format": "etag", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "source-modified-access-conditions" @@ -12907,7 +12053,6 @@ "in": "header", "required": true, "type": "string", - "format": "url", "x-ms-parameter-location": "method", "description": "Specify a URL to the copy source." }, @@ -12929,66 +12074,6 @@ "minimum": 0, "x-ms-parameter-location": "method", "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations." - }, - "XMsCacheControl": { - "name": "x-ms-cache-control", - "x-ms-client-name": "cacheControl", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "directory-http-headers" - }, - "description": "Cache control for given resource" - }, - "XMsContentType": { - "name": "x-ms-content-type", - "x-ms-client-name": "contentType", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "directory-http-headers" - }, - "description": "Content type for given resource" - }, - "XMsContentEncoding": { - "name": "x-ms-content-encoding", - "x-ms-client-name": "contentEncoding", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "directory-http-headers" - }, - "description": "Content encoding for given resource" - }, - "XMsContentLanguage": { - "name": "x-ms-content-language", - "x-ms-client-name": "contentLanguage", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "directory-http-headers" - }, - "description": "Content language for given resource" - }, - "XMsContentDisposition": { - "name": "x-ms-content-disposition", - "x-ms-client-name": "contentDisposition", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "directory-http-headers" - }, - "description": "Content disposition for given resource" } } } diff --git a/specification/storage/data-plane/Microsoft.BlobStorage/readme.md b/specification/storage/data-plane/Microsoft.BlobStorage/readme.md new file mode 100644 index 000000000000..90f57f1ebb58 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.BlobStorage/readme.md @@ -0,0 +1,53 @@ +# BlobStorage + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for BlobStorage. + + +--- +## Getting Started +To build the SDK for BlobStorage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the BlobStorage API. + +``` yaml +openapi-type: data-plane +tag: package-2020-10 +use-internal-constructors: true +add-credentials: true +``` + +### Tag: package-2020-10 + +These settings apply only when `--tag=package-2020-10` is specified on the command line. + +``` yaml $(tag) == 'package-2020-10' +input-file: +- preview/2020-10-02/blob.json +``` + +### Suppression +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: preview/2020-10-02/blob.json + reason: These parameters are predfined by storage specifications + - suppress: XmsPathsMustOverloadPaths + from: preview/2020-10-02/blob.json + - suppress: XmsExamplesRequired + from: preview/2020-10-02/blob.json +``` +--- \ No newline at end of file diff --git a/specification/storage/data-plane/Microsoft.FileStorage/preview/2020-10-02/file.json b/specification/storage/data-plane/Microsoft.FileStorage/preview/2020-10-02/file.json index 5aefd6814761..cd4fd0e10157 100644 --- a/specification/storage/data-plane/Microsoft.FileStorage/preview/2020-10-02/file.json +++ b/specification/storage/data-plane/Microsoft.FileStorage/preview/2020-10-02/file.json @@ -1,6404 +1,6702 @@ { - "swagger": "2.0", - "info": { - "title": "Azure File Storage", - "version": "2020-10-02", - "x-ms-code-generation-settings": { - "header": "MIT", - "strictSpecAdherence": false + "swagger": "2.0", + "info": { + "title": "Azure File Storage", + "version": "2020-10-02", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "securityDefinitions": { + "File_shared_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "paths": {}, + "x-ms-paths": { + "/?restype=service&comp=properties": { + "put": { + "tags": [ + "service" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's File service endpoint, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{url}", - "useSchemePrefix": false, - "positionInOperation": "first", - "parameters": [{ - "$ref": "#/parameters/Url" - }] - }, - "securityDefinitions": { - "File_shared_key": { - "type": "apiKey", - "name": "Authorization", - "in": "header" + }, + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetProperties", + "description": "Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] } + ] }, - "schemes": [ - "https" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "paths": { - - }, - "x-ms-paths": { - "/?restype=service&comp=properties": { - "put": { - "tags": [ - "service" - ], - "operationId": "Service_SetProperties", - "description": "Sets properties for a storage account's File service endpoint, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", - "parameters": [{ - "$ref": "#/parameters/StorageServiceProperties" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Success (Accepted)", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + "/?comp=list": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_ListSharesSegment", + "description": "The List Shares Segment operation returns a list of the shares and share snapshots under the specified account.", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListSharesInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } }, - "get": { - "tags": [ - "service" - ], - "operationId": "Service_GetProperties", - "description": "Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - } - }, - "schema": { - "$ref": "#/definitions/StorageServiceProperties" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + "schema": { + "$ref": "#/definitions/ListSharesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "properties" - ] - } - ] + "schema": { + "$ref": "#/definitions/StorageError" + } + } }, - "/?comp=list": { - "get": { - "tags": [ - "service" - ], - "operationId": "Service_ListSharesSegment", - "description": "The List Shares Segment operation returns a list of the shares and share snapshots under the specified account.", - "parameters": [{ - "$ref": "#/parameters/Prefix" - }, - { - "$ref": "#/parameters/Marker" - }, - { - "$ref": "#/parameters/MaxResults" - }, - { - "$ref": "#/parameters/ListSharesInclude" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - } - }, - "schema": { - "$ref": "#/definitions/ListSharesResponse" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "NextMarker" - } + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{shareName}?restype=share": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_Create", + "description": "Creates a new share under the specified account. If the share with the same name already exists, the operation fails.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ShareQuota" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareEnabledProtocols" + }, + { + "$ref": "#/parameters/ShareRootSquash" + } + ], + "responses": { + "201": { + "description": "Success, Share created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the share, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetProperties", + "description": "Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs that contain the user-defined metadata of the share.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-share-quota": { + "x-ms-client-name": "Quota", + "type": "integer", + "description": "Returns the current share quota in GB." + }, + "x-ms-share-provisioned-iops": { + "x-ms-client-name": "ProvisionedIops", + "type": "integer", + "description": "Returns the current share provisioned ipos." + }, + "x-ms-share-provisioned-ingress-mbps": { + "x-ms-client-name": "ProvisionedIngressMBps", + "type": "integer", + "description": "Returns the current share provisioned ingress in megabytes per second." + }, + "x-ms-share-provisioned-egress-mbps": { + "x-ms-client-name": "ProvisionedEgressMBps", + "type": "integer", + "description": "Returns the current share provisioned egress in megabytes per second." + }, + "x-ms-share-next-allowed-quota-downgrade-time": { + "x-ms-client-name": "NextAllowedQuotaDowngradeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the current share next allowed quota downgrade time." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", "type": "string", "enum": [ - "list" - ] - }] - }, - "/{shareName}?restype=share": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_Create", - "description": "Creates a new share under the specified account. If the share with the same name already exists, the operation fails.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Metadata" - }, - { - "$ref": "#/parameters/ShareQuota" - }, - { - "$ref": "#/parameters/AccessTierOptional" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ShareEnabledProtocols" - }, - { - "$ref": "#/parameters/ShareRootSquash" - } - ], - "responses": { - "201": { - "description": "Success, Share created.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the share, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "get": { - "tags": [ - "share" + "infinite", + "fixed" ], - "operationId": "Share_GetProperties", - "description": "Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files.", - "parameters": [{ - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Success", - "headers": { - "x-ms-meta": { - "type": "string", - "description": "A set of name-value pairs that contain the user-defined metadata of the share.", - "x-ms-client-name": "Metadata", - "x-ms-header-collection-prefix": "x-ms-meta-" - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-share-quota": { - "x-ms-client-name": "Quota", - "type": "integer", - "description": "Returns the current share quota in GB." - }, - "x-ms-share-provisioned-iops": { - "x-ms-client-name": "ProvisionedIops", - "type": "integer", - "description": "Returns the current share provisioned ipos." - }, - "x-ms-share-provisioned-ingress-mbps": { - "x-ms-client-name": "ProvisionedIngressMBps", - "type": "integer", - "description": "Returns the current share provisioned ingress in megabytes per second." - }, - "x-ms-share-provisioned-egress-mbps": { - "x-ms-client-name": "ProvisionedEgressMBps", - "type": "integer", - "description": "Returns the current share provisioned egress in megabytes per second." - }, - "x-ms-share-next-allowed-quota-downgrade-time": { - "x-ms-client-name": "NextAllowedQuotaDowngradeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the current share next allowed quota downgrade time." - }, - "x-ms-lease-duration": { - "x-ms-client-name": "LeaseDuration", - "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", - "type": "string", - "enum": [ - "infinite", - "fixed" - ], - "x-ms-enum": { - "name": "LeaseDurationType", - "modelAsString": false - } - }, - "x-ms-lease-state": { - "x-ms-client-name": "LeaseState", - "description": "Lease state of the share.", - "type": "string", - "enum": [ - "available", - "leased", - "expired", - "breaking", - "broken" - ], - "x-ms-enum": { - "name": "LeaseStateType", - "modelAsString": false - } - }, - "x-ms-lease-status": { - "x-ms-client-name": "LeaseStatus", - "description": "The current lease status of the share.", - "type": "string", - "enum": [ - "locked", - "unlocked" - ], - "x-ms-enum": { - "name": "LeaseStatusType", - "modelAsString": false - } - }, - "x-ms-access-tier": { - "x-ms-client-name": "AccessTier", - "type": "string", - "description": "Returns the access tier set on the share." - }, - "x-ms-access-tier-change-time": { - "x-ms-client-name": "AccessTierChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the last modified time (in UTC) of the access tier of the share." - }, - "x-ms-access-tier-transition-state": { - "x-ms-client-name": "AccessTierTransitionState", - "type": "string", - "description": "Returns the transition state betweeen access tiers, when present." - }, - "x-ms-enabled-protocols": { - "x-ms-client-name": "EnabledProtocols", - "description": "The protocols that have been enabled on the share.", - "type": "string" - }, - "x-ms-root-squash": { - "x-ms-client-name": "RootSquash", - "description": "Valid for NFS shares only.", - "type": "string", - "enum": [ - "NoRootSquash", - "RootSquash", - "AllSquash" - ], - "x-ms-enum": { - "name": "ShareRootSquash", - "modelAsString": false - } - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false } - }, - "delete": { - "tags": [ - "share" - ], - "operationId": "Share_Delete", - "description": "Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection.", - "parameters": [{ - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/DeleteSnapshots" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the share.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false } - }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the share.", "type": "string", "enum": [ - "share" - ] - }] - }, - "/{shareName}?restype=share&comp=lease&acquire": { - "put": { - "tags": [ - "share" + "locked", + "unlocked" ], - "operationId": "Share_AcquireLease", - "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseDuration" - }, - { - "$ref": "#/parameters/ProposedLeaseIdOptional" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "201": { - "description": "The Acquire operation completed successfully.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-lease-id": { - "x-ms-client-name": "LeaseId", - "type": "string", - "description": "Uniquely identifies a share's lease" - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "lease" - ] - }, - { - "name": "x-ms-lease-action", - "x-ms-client-name": "action", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "acquire" - ], - "x-ms-enum": { - "name": "LeaseAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Describes what lease action to take." - }, - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false } - ] - }, - "/{shareName}?restype=share&comp=lease&release": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_ReleaseLease", - "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdRequired" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/ClientRequestId" - } + }, + "x-ms-access-tier": { + "x-ms-client-name": "AccessTier", + "type": "string", + "description": "Returns the access tier set on the share." + }, + "x-ms-access-tier-change-time": { + "x-ms-client-name": "AccessTierChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the last modified time (in UTC) of the access tier of the share." + }, + "x-ms-access-tier-transition-state": { + "x-ms-client-name": "AccessTierTransitionState", + "type": "string", + "description": "Returns the transition state between access tiers, when present." + }, + "x-ms-enabled-protocols": { + "x-ms-client-name": "EnabledProtocols", + "description": "The protocols that have been enabled on the share.", + "type": "string" + }, + "x-ms-root-squash": { + "x-ms-client-name": "RootSquash", + "description": "Valid for NFS shares only.", + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" ], - "responses": { - "200": { - "description": "The Release operation completed successfully.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "lease" - ] - }, - { - "name": "x-ms-lease-action", - "x-ms-client-name": "action", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "release" - ], - "x-ms-enum": { - "name": "LeaseAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Describes what lease action to take." - }, - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - } - ] - }, - "/{shareName}?restype=share&comp=lease&change": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_ChangeLease", - "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdRequired" - }, - { - "$ref": "#/parameters/ProposedLeaseIdOptional" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "200": { - "description": "The Change operation completed successfully.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-lease-id": { - "x-ms-client-name": "LeaseId", - "type": "string", - "description": "Uniquely identifies a share's lease" - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "share" + ], + "operationId": "Share_Delete", + "description": "Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DeleteSnapshots" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "lease" - ] - }, - { - "name": "x-ms-lease-action", - "x-ms-client-name": "action", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "change" - ], - "x-ms-enum": { - "name": "LeaseAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Describes what lease action to take." - }, - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - } - ] - }, - "/{shareName}?restype=share&comp=lease&renew": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_RenewLease", - "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdRequired" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "200": { - "description": "The Renew operation completed successfully.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-lease-id": { - "x-ms-client-name": "LeaseId", - "type": "string", - "description": "Uniquely identifies a share's lease" - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the current share next allowed quota downgrade time." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&acquire": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_AcquireLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "lease" - ] - }, - { - "name": "x-ms-lease-action", - "x-ms-client-name": "action", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "renew" - ], - "x-ms-enum": { - "name": "LeaseAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Describes what lease action to take." - }, - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - } - ] + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] }, - "/{shareName}?restype=share&comp=lease&break": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_BreakLease", - "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseBreakPeriod" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ShareSnapshot" - } - ], - "responses": { - "202": { - "description": "The Break operation completed successfully.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-lease-time": { - "x-ms-client-name": "LeaseTime", - "type": "integer", - "description": "Approximate time remaining in the lease period, in seconds." - }, - "x-ms-lease-id": { - "x-ms-client-name": "LeaseId", - "type": "string", - "description": "Uniquely identifies a share's lease" - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "lease" - ] - }, - { - "name": "x-ms-lease-action", - "x-ms-client-name": "action", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "break" - ], - "x-ms-enum": { - "name": "LeaseAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Describes what lease action to take." - }, - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - } - ] + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." }, - "/{shareName}?restype=share&comp=snapshot": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_CreateSnapshot", - "description": "Creates a read-only snapshot of a share.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Metadata" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "Success, Share snapshot created.", - "headers": { - "x-ms-snapshot": { - "x-ms-client-name": "Snapshot", - "type": "string", - "description": "This header is a DateTime value that uniquely identifies the share snapshot. The value of this header may be used in subsequent requests to access the share snapshot. This value is opaque." - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the share snapshot, in quotes. A share snapshot cannot be modified, so the ETag of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the ETag of the share snapshot differs from that of the base share. If no metadata was specified with the request, the ETag of the share snapshot is identical to that of the base share at the time the share snapshot was taken." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. A share snapshot cannot be modified, so the last modified time of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the last modified time of the share snapshot differs from that of the base share. If no metadata was specified with the request, the last modified time of the share snapshot is identical to that of the base share at the time the share snapshot was taken." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&release": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_ReleaseLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "snapshot" - ] - } - ] + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] }, - "/{shareName}?restype=share&comp=filepermission": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_CreatePermission", - "description": "Create a permission (a security descriptor).", - "consumes": [ - "application/json" - ], - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SharePermission" - } - ], - "responses": { - "201": { - "description": "Success, Share level permission created.", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-file-permission-key": { - "x-ms-client-name": "FilePermissionKey", - "type": "string", - "description": "Key of the permission set for the directory/file." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "get": { - "tags": [ - "share" - ], - "operationId": "Share_GetPermission", - "description": "Returns the permission (security descriptor) for a given key", - "produces": [ - "application/json" - ], - "parameters": [{ - "$ref": "#/parameters/FilePermissionKeyRequired" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - }, - "schema": { - "$ref": "#/definitions/SharePermission" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "filepermission" - ] - } - ] + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." }, - "/{shareName}?restype=share&comp=properties": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_SetProperties", - "description": "Sets properties for the specified share.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ShareQuota" - }, - { - "$ref": "#/parameters/AccessTierOptional" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/ShareRootSquash" - } - ], - "responses": { - "200": { - "description": "Success", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&change": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_ChangeLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "properties" - ] - } - ] + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] }, - "/{shareName}?restype=share&comp=metadata": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_SetMetadata", - "description": "Sets one or more user-defined name-value pairs for the specified share.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Metadata" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Success", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&renew": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_RenewLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Renew operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the current share next allowed quota downgrade time." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "renew" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&break": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_BreakLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseBreakPeriod" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ShareSnapshot" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "type": "integer", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=snapshot": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_CreateSnapshot", + "description": "Creates a read-only snapshot of a share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Success, Share snapshot created.", + "headers": { + "x-ms-snapshot": { + "x-ms-client-name": "Snapshot", + "type": "string", + "description": "This header is a DateTime value that uniquely identifies the share snapshot. The value of this header may be used in subsequent requests to access the share snapshot. This value is opaque." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the share snapshot, in quotes. A share snapshot cannot be modified, so the ETag of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the ETag of the share snapshot differs from that of the base share. If no metadata was specified with the request, the ETag of the share snapshot is identical to that of the base share at the time the share snapshot was taken." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. A share snapshot cannot be modified, so the last modified time of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the last modified time of the share snapshot differs from that of the base share. If no metadata was specified with the request, the last modified time of the share snapshot is identical to that of the base share at the time the share snapshot was taken." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "snapshot" + ] + } + ] + }, + "/{shareName}?restype=share&comp=filepermission": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_CreatePermission", + "description": "Create a permission (a security descriptor).", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SharePermission" + } + ], + "responses": { + "201": { + "description": "Success, Share level permission created.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory/file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetPermission", + "description": "Returns the permission (security descriptor) for a given key", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FilePermissionKeyRequired" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/SharePermission" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "filepermission" + ] + } + ] + }, + "/{shareName}?restype=share&comp=properties": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetProperties", + "description": "Sets properties for the specified share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareQuota" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ShareRootSquash" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}?restype=share&comp=metadata": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetMetadata", + "description": "Sets one or more user-defined name-value pairs for the specified share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}?restype=share&comp=acl": { + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetAccessPolicy", + "description": "Returns information about stored access policies specified on the share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetAccessPolicy", + "description": "Sets a stored access policy for use with shared access signatures.", + "parameters": [ + { + "$ref": "#/parameters/ShareAcl" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ] + } + ] + }, + "/{shareName}?restype=share&comp=stats": { + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetStatistics", + "description": "Retrieves statistics related to the share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ShareStats" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ] + } + ] + }, + "/{shareName}?restype=share&comp=undelete": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_Restore", + "description": "Restores a previously deleted Share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DeletedShareName" + }, + { + "$ref": "#/parameters/DeletedShareVersion" + } + ], + "responses": { + "201": { + "description": "Created", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "undelete" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_Create", + "description": "Creates a new directory under the specified share or parent directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + } + ], + "responses": { + "201": { + "description": "Success, Directory created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the directory, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_GetProperties", + "description": "Returns all system properties for the specified directory, and can also be used to check the existence of a directory. The data returned does not include the files in the directory or any subdirectories.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs that contain metadata for the directory.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "directory" + ], + "operationId": "Directory_Delete", + "description": "Removes the specified empty directory. Note that the directory must be empty before it can be deleted.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success (Accepted).", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=properties": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_SetProperties", + "description": "Sets properties on the directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "metadata" - ] - } - ] + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "/{shareName}?restype=share&comp=acl": { - "get": { - "tags": [ - "share" - ], - "operationId": "Share_GetAccessPolicy", - "description": "Returns information about stored access policies specified on the share.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Success", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - }, - "schema": { - "$ref": "#/definitions/SignedIdentifiers" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "put": { - "tags": [ - "share" - ], - "operationId": "Share_SetAccessPolicy", - "description": "Sets a stored access policy for use with shared access signatures.", - "parameters": [{ - "$ref": "#/parameters/ShareAcl" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "acl" - ] - } - ] + { + "$ref": "#/parameters/DirectoryPath" }, - "/{shareName}?restype=share&comp=stats": { - "get": { - "tags": [ - "share" - ], - "operationId": "Share_GetStatistics", - "description": "Retrieves statistics related to the share.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Success", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - }, - "schema": { - "$ref": "#/definitions/ShareStats" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=metadata": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_SetMetadata", + "description": "Updates user defined metadata for the specified directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success (OK).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the directory, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "stats" - ] - } - ] + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "/{shareName}?restype=share&comp=undelete": { - "put": { - "tags": [ - "share" - ], - "operationId": "Share_Restore", - "description": "Restores a previously deleted Share.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DeletedShareName" - }, - { - "$ref": "#/parameters/DeletedShareVersion" - } - ], - "responses": { - "201": { - "description": "Created", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "share" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "undelete" - ] - } - ] + { + "$ref": "#/parameters/DirectoryPath" }, - "/{shareName}/{directory}?restype=directory": { - "put": { - "tags": [ - "directory" - ], - "operationId": "Directory_Create", - "description": "Creates a new directory under the specified share or parent directory.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Metadata" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/FilePermission" - }, - { - "$ref": "#/parameters/FilePermissionKey" - }, - { - "$ref": "#/parameters/FileAttributes" - }, - { - "$ref": "#/parameters/FileCreationTime" - }, - { - "$ref": "#/parameters/FileLastWriteTime" - } - ], - "responses": { - "201": { - "description": "Success, Directory created.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the directory, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." - }, - "x-ms-file-permission-key": { - "x-ms-client-name": "FilePermissionKey", - "type": "string", - "description": "Key of the permission set for the directory." - }, - "x-ms-file-attributes": { - "x-ms-client-name": "FileAttributes", - "type": "string", - "description": "Attributes set for the directory." - }, - "x-ms-file-creation-time": { - "x-ms-client-name": "FileCreationTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Creation time for the directory." - }, - "x-ms-file-last-write-time": { - "x-ms-client-name": "FileLastWriteTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Last write time for the directory." - }, - "x-ms-file-change-time": { - "x-ms-client-name": "FileChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Change time for the directory." - }, - "x-ms-file-id": { - "x-ms-client-name": "FileId", - "type": "string", - "description": "The fileId of the directory." - }, - "x-ms-file-parent-id": { - "x-ms-client-name": "FileParentId", - "type": "string", - "description": "The parent fileId of the directory." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "get": { - "tags": [ - "directory" - ], - "operationId": "Directory_GetProperties", - "description": "Returns all system properties for the specified directory, and can also be used to check the existence of a directory. The data returned does not include the files in the directory or any subdirectories.", - "parameters": [{ - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-meta": { - "type": "string", - "description": "A set of name-value pairs that contain metadata for the directory.", - "x-ms-client-name": "Metadata", - "x-ms-header-collection-prefix": "x-ms-meta-" - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false." - }, - "x-ms-file-attributes": { - "x-ms-client-name": "FileAttributes", - "type": "string", - "description": "Attributes set for the directory." - }, - "x-ms-file-creation-time": { - "x-ms-client-name": "FileCreationTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Creation time for the directory." - }, - "x-ms-file-last-write-time": { - "x-ms-client-name": "FileLastWriteTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Last write time for the directory." - }, - "x-ms-file-change-time": { - "x-ms-client-name": "FileChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Change time for the directory." - }, - "x-ms-file-permission-key": { - "x-ms-client-name": "FilePermissionKey", - "type": "string", - "description": "Key of the permission set for the directory." - }, - "x-ms-file-id": { - "x-ms-client-name": "FileId", - "type": "string", - "description": "The fileId of the directory." - }, - "x-ms-file-parent-id": { - "x-ms-client-name": "FileParentId", - "type": "string", - "description": "The parent fileId of the directory." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=list": { + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_ListFilesAndDirectoriesSegment", + "description": "Returns a list of files or directories under the specified share or directory. It lists the contents only for a single level of the directory hierarchy.", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListFilesInclude" + }, + { + "$ref": "#/parameters/ListFilesExtendedInfo" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } }, - "delete": { - "tags": [ - "directory" - ], - "operationId": "Directory_Delete", - "description": "Removes the specified empty directory. Note that the directory must be empty before it can be deleted.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Success (Accepted).", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + "schema": { + "$ref": "#/definitions/ListFilesAndDirectoriesSegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "directory" - ] - }] + "schema": { + "$ref": "#/definitions/StorageError" + } + } }, - "/{shareName}/{directory}?restype=directory&comp=properties": { - "put": { - "tags": [ - "directory" - ], - "operationId": "Directory_SetProperties", - "description": "Sets properties on the directory.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/FilePermission" - }, - { - "$ref": "#/parameters/FilePermissionKey" - }, - { - "$ref": "#/parameters/FileAttributes" - }, - { - "$ref": "#/parameters/FileCreationTime" - }, - { - "$ref": "#/parameters/FileLastWriteTime" - } - ], - "responses": { - "200": { - "description": "Success", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the file, in quotes." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." - }, - "x-ms-file-permission-key": { - "x-ms-client-name": "FilePermissionKey", - "type": "string", - "description": "Key of the permission set for the directory." - }, - "x-ms-file-attributes": { - "x-ms-client-name": "FileAttributes", - "type": "string", - "description": "Attributes set for the directory." - }, - "x-ms-file-creation-time": { - "x-ms-client-name": "FileCreationTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Creation time for the directory." - }, - "x-ms-file-last-write-time": { - "x-ms-client-name": "FileLastWriteTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Last write time for the directory." - }, - "x-ms-file-change-time": { - "x-ms-client-name": "FileChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Change time for the directory." - }, - "x-ms-file-id": { - "x-ms-client-name": "FileId", - "type": "string", - "description": "The fileId of the directory." - }, - "x-ms-file-parent-id": { - "x-ms-client-name": "FileParentId", - "type": "string", - "description": "The parent fileId of the directory." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "directory" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "properties" - ] - } - ] + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "/{shareName}/{directory}?restype=directory&comp=metadata": { - "put": { - "tags": [ - "directory" - ], - "operationId": "Directory_SetMetadata", - "description": "Updates user defined metadata for the specified directory.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Metadata" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success (OK).", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the directory, in quotes." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "directory" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "metadata" - ] - } - ] + { + "$ref": "#/parameters/DirectoryPath" }, - "/{shareName}/{directory}?restype=directory&comp=list": { - "get": { - "tags": [ - "directory" - ], - "operationId": "Directory_ListFilesAndDirectoriesSegment", - "description": "Returns a list of files or directories under the specified share or directory. It lists the contents only for a single level of the directory hierarchy.", - "parameters": [ - { - "$ref": "#/parameters/Prefix" - }, - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/Marker" - }, - { - "$ref": "#/parameters/MaxResults" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ListFilesInclude" - }, - { - "$ref": "#/parameters/ListFilesExtendedInfo" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "Content-Type": { - "type": "string", - "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - }, - "schema": { - "$ref": "#/definitions/ListFilesAndDirectoriesSegmentResponse" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "NextMarker" - } + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{shareName}/{directory}?comp=listhandles": { + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_ListHandles", + "description": "Lists handles for directory.", + "parameters": [ + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Recursive" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } }, - "parameters": [{ - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "directory" - ] - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "list" - ] - } - ] - }, - "/{shareName}/{directory}?comp=listhandles": { - "get":{ - "tags": [ - "directory" - ], - "operationId": "Directory_ListHandles", - "description": "Lists handles for directory.", - "parameters":[ - { - "$ref": "#/parameters/Marker" - }, - { - "$ref": "#/parameters/MaxResults" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/Recursive" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "Content-Type": { - "type": "string", - "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - }, - "schema": { - "$ref": "#/definitions/ListHandlesResponse" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + "schema": { + "$ref": "#/definitions/ListHandlesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "listhandles" - ] - } - ] + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "/{shareName}/{directory}?comp=forceclosehandles": { - "put": { - "tags": [ - "directory" - ], - "operationId": "Directory_ForceCloseHandles", - "description": "Closes all handles open for given directory.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Marker" - }, - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/HandleId" - }, - { - "$ref": "#/parameters/Recursive" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-marker": { - "x-ms-client-name": "marker", - "type": "string", - "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." - }, - "x-ms-number-of-handles-closed": { - "x-ms-client-name": "numberOfHandlesClosed", - "type": "integer", - "description": "Contains count of number of handles closed." - }, - "x-ms-number-of-handles-failed": { - "x-ms-client-name": "numberOfHandlesFailedToClose", - "type": "integer", - "description": "Contains count of number of handles that failed to close." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "listhandles" + ] + } + ] + }, + "/{shareName}/{directory}?comp=forceclosehandles": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_ForceCloseHandles", + "description": "Closes all handles open for given directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/HandleId" + }, + { + "$ref": "#/parameters/Recursive" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", "type": "string", - "enum": [ - "forceclosehandles" - ] + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-marker": { + "x-ms-client-name": "marker", + "type": "string", + "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." + }, + "x-ms-number-of-handles-closed": { + "x-ms-client-name": "numberOfHandlesClosed", + "type": "integer", + "description": "Contains count of number of handles closed." + }, + "x-ms-number-of-handles-failed": { + "x-ms-client-name": "numberOfHandlesFailedToClose", + "type": "integer", + "description": "Contains count of number of handles that failed to close." + } } - ] - }, - "/{shareName}/{directory}/{fileName}": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_Create", - "description": "Creates a new file or replaces a file. Note it only initializes the file with no content.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "x-ms-content-length", - "x-ms-client-name": "fileContentLength", - "in": "header", - "description": "Specifies the maximum size for the file, up to 4 TB.", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "$ref": "#/parameters/FileType" - }, - { - "$ref": "#/parameters/FileContentType" - }, - { - "$ref": "#/parameters/FileContentEncoding" - }, - { - "$ref": "#/parameters/FileContentLanguage" - }, - { - "$ref": "#/parameters/FileCacheControl" - }, - { - "$ref": "#/parameters/FileContentMD5" - }, - { - "$ref": "#/parameters/FileContentDisposition" - }, - { - "$ref": "#/parameters/Metadata" - }, - { - "$ref": "#/parameters/FilePermission" - }, - { - "$ref": "#/parameters/FilePermissionKey" - }, - { - "$ref": "#/parameters/FileAttributes" - }, - { - "$ref": "#/parameters/FileCreationTime" - }, - { - "$ref": "#/parameters/FileLastWriteTime" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "201": { - "description": "Success, File created.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the file, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." - }, - "x-ms-file-permission-key": { - "x-ms-client-name": "FilePermissionKey", - "type": "string", - "description": "Key of the permission set for the file." - }, - "x-ms-file-attributes": { - "x-ms-client-name": "FileAttributes", - "type": "string", - "description": "Attributes set for the file." - }, - "x-ms-file-creation-time": { - "x-ms-client-name": "FileCreationTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Creation time for the file." - }, - "x-ms-file-last-write-time": { - "x-ms-client-name": "FileLastWriteTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Last write time for the file." - }, - "x-ms-file-change-time": { - "x-ms-client-name": "FileChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Change time for the file." - }, - "x-ms-file-id": { - "x-ms-client-name": "FileId", - "type": "string", - "description": "The fileId of the file." - }, - "x-ms-file-parent-id": { - "x-ms-client-name": "FileParentId", - "type": "string", - "description": "The parent fileId of the file." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "get": { - "tags": [ - "file" - ], - "operationId": "File_Download", - "description": "Reads or downloads a file from the system, including its metadata and properties.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/Range" - }, - { - "$ref": "#/parameters/GetRangeContentMD5" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Succeeded to read the entire file.", - "headers": { - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." - }, - "x-ms-meta": { - "type": "string", - "description": "A set of name-value pairs associated with this file as user-defined metadata.", - "x-ms-client-name": "Metadata", - "x-ms-header-collection-prefix": "x-ms-meta-" - }, - "Content-Length": { - "type": "integer", - "format": "int64", - "description": "The number of bytes present in the response body." - }, - "Content-Type": { - "type": "string", - "description": "The content type specified for the file. The default content type is 'application/octet-stream'" - }, - "Content-Range": { - "type": "string", - "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Content-MD5": { - "type": "string", - "format": "byte", - "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." - }, - "Content-Encoding": { - "type": "string", - "description": "Returns the value that was specified for the Content-Encoding request header." - }, - "Cache-Control": { - "type": "string", - "description": "Returned if it was previously specified for the file." - }, - "Content-Disposition": { - "type": "string", - "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." - }, - "Content-Language": { - "type": "string", - "description": "Returns the value that was specified for the Content-Language request header." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Accept-Ranges": { - "type": "string", - "description": "Indicates that the service supports requests for partial file content." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-copy-completion-time": { - "x-ms-client-name": "CopyCompletionTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." - }, - "x-ms-copy-status-description": { - "x-ms-client-name": "CopyStatusDescription", - "type": "string", - "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." - }, - "x-ms-copy-id": { - "x-ms-client-name": "CopyId", - "type": "string", - "description": "String identifier for the last attempted Copy File operation where this file was the destination file." - }, - "x-ms-copy-progress": { - "x-ms-client-name": "CopyProgress", - "type": "string", - "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." - }, - "x-ms-copy-source": { - "x-ms-client-name": "CopySource", - "type": "string", - "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." - }, - "x-ms-copy-status": { - "x-ms-client-name": "CopyStatus", - "description": "State of the copy operation identified by 'x-ms-copy-id'.", - "type": "string", - "enum": [ - "pending", - "success", - "aborted", - "failed" - ], - "x-ms-enum": { - "name": "CopyStatusType", - "modelAsString": false - } - }, - "x-ms-content-md5": { - "x-ms-client-name": "FileContentMD5", - "type": "string", - "format": "byte", - "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." - }, - "x-ms-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." - }, - "x-ms-file-attributes": { - "x-ms-client-name": "FileAttributes", - "type": "string", - "description": "Attributes set for the file." - }, - "x-ms-file-creation-time": { - "x-ms-client-name": "FileCreationTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Creation time for the file." - }, - "x-ms-file-last-write-time": { - "x-ms-client-name": "FileLastWriteTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Last write time for the file." - }, - "x-ms-file-change-time": { - "x-ms-client-name": "FileChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Change time for the file." - }, - "x-ms-file-permission-key": { - "x-ms-client-name": "FilePermissionKey", - "type": "string", - "description": "Key of the permission set for the file." - }, - "x-ms-file-id": { - "x-ms-client-name": "FileId", - "type": "string", - "description": "The fileId of the file." - }, - "x-ms-file-parent-id": { - "x-ms-client-name": "FileParentId", - "type": "string", - "description": "The parent fileId of the file." - }, - "x-ms-lease-duration": { - "x-ms-client-name": "LeaseDuration", - "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", - "type": "string", - "enum": [ - "infinite", - "fixed" - ], - "x-ms-enum": { - "name": "LeaseDurationType", - "modelAsString": false - } - }, - "x-ms-lease-state": { - "x-ms-client-name": "LeaseState", - "description": "Lease state of the file.", - "type": "string", - "enum": [ - "available", - "leased", - "expired", - "breaking", - "broken" - ], - "x-ms-enum": { - "name": "LeaseStateType", - "modelAsString": false - } - }, - "x-ms-lease-status": { - "x-ms-client-name": "LeaseStatus", - "description": "The current lease status of the file.", - "type": "string", - "enum": [ - "locked", - "unlocked" - ], - "x-ms-enum": { - "name": "LeaseStatusType", - "modelAsString": false - } - } - }, - "schema": { - "type": "object", - "format": "file" - } - }, - "206": { - "description": "Succeeded to read a specified range of the file.", - "headers": { - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." - }, - "x-ms-meta": { - "type": "string", - "description": "A set of name-value pairs associated with this file as user-defined metadata.", - "x-ms-client-name": "Metadata", - "x-ms-header-collection-prefix": "x-ms-meta-" - }, - "Content-Length": { - "type": "integer", - "format": "int64", - "description": "The number of bytes present in the response body." - }, - "Content-Type": { - "type": "string", - "description": "The content type specified for the file. The default content type is 'application/octet-stream'" - }, - "Content-Range": { - "type": "string", - "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Content-MD5": { - "type": "string", - "format": "byte", - "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." - }, - "Content-Encoding": { - "type": "string", - "description": "Returns the value that was specified for the Content-Encoding request header." - }, - "Cache-Control": { - "type": "string", - "description": "Returned if it was previously specified for the file." - }, - "Content-Disposition": { - "type": "string", - "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." - }, - "Content-Language": { - "type": "string", - "description": "Returns the value that was specified for the Content-Language request header." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Accept-Ranges": { - "type": "string", - "description": "Indicates that the service supports requests for partial file content." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-copy-completion-time": { - "x-ms-client-name": "CopyCompletionTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." - }, - "x-ms-copy-status-description": { - "x-ms-client-name": "CopyStatusDescription", - "type": "string", - "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." - }, - "x-ms-copy-id": { - "x-ms-client-name": "CopyId", - "type": "string", - "description": "String identifier for the last attempted Copy File operation where this file was the destination file." - }, - "x-ms-copy-progress": { - "x-ms-client-name": "CopyProgress", - "type": "string", - "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." - }, - "x-ms-copy-source": { - "x-ms-client-name": "CopySource", - "type": "string", - "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." - }, - "x-ms-copy-status": { - "x-ms-client-name": "CopyStatus", - "description": "State of the copy operation identified by 'x-ms-copy-id'.", - "type": "string", - "enum": [ - "pending", - "success", - "aborted", - "failed" - ], - "x-ms-enum": { - "name": "CopyStatusType", - "modelAsString": false - } - }, - "x-ms-content-md5": { - "x-ms-client-name": "FileContentMD5", - "type": "string", - "format": "byte", - "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." - }, - "x-ms-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." - }, - "x-ms-file-attributes": { - "x-ms-client-name": "FileAttributes", - "type": "string", - "description": "Attributes set for the file." - }, - "x-ms-file-creation-time": { - "x-ms-client-name": "FileCreationTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Creation time for the file." - }, - "x-ms-file-last-write-time": { - "x-ms-client-name": "FileLastWriteTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Last write time for the file." - }, - "x-ms-file-change-time": { - "x-ms-client-name": "FileChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Change time for the file." - }, - "x-ms-file-permission-key": { - "x-ms-client-name": "FilePermissionKey", - "type": "string", - "description": "Key of the permission set for the file." - }, - "x-ms-file-id": { - "x-ms-client-name": "FileId", - "type": "string", - "description": "The fileId of the file." - }, - "x-ms-file-parent-id": { - "x-ms-client-name": "FileParentId", - "type": "string", - "description": "The parent fileId of the file." - }, - "x-ms-lease-duration": { - "x-ms-client-name": "LeaseDuration", - "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", - "type": "string", - "enum": [ - "infinite", - "fixed" - ], - "x-ms-enum": { - "name": "LeaseDurationType", - "modelAsString": false - } - }, - "x-ms-lease-state": { - "x-ms-client-name": "LeaseState", - "description": "Lease state of the file.", - "type": "string", - "enum": [ - "available", - "leased", - "expired", - "breaking", - "broken" - ], - "x-ms-enum": { - "name": "LeaseStateType", - "modelAsString": false - } - }, - "x-ms-lease-status": { - "x-ms-client-name": "LeaseStatus", - "description": "The current lease status of the file.", - "type": "string", - "enum": [ - "locked", - "unlocked" - ], - "x-ms-enum": { - "name": "LeaseStatusType", - "modelAsString": false - } - } - }, - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "head": { - "tags": [ - "file" - ], - "operationId": "File_GetProperties", - "description": "Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.", - "parameters": [ - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time." - }, - "x-ms-meta": { - "type": "string", - "description": "A set of name-value pairs associated with this file as user-defined metadata.", - "x-ms-client-name": "Metadata", - "x-ms-header-collection-prefix": "x-ms-meta-" - }, - "x-ms-type": { - "x-ms-client-name": "FileType", - "description": "Returns the type File. Reserved for future use.", - "type": "string", - "enum": [ - "File" - ] - }, - "Content-Length": { - "type": "integer", - "format": "int64", - "description": "The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file." - }, - "Content-Type": { - "type": "string", - "description": "The content type specified for the file. The default content type is 'application/octet-stream'" - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." - }, - "Content-MD5": { - "type": "string", - "format": "byte", - "description": "If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity." - }, - "Content-Encoding": { - "type": "string", - "description": "If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header." - }, - "Cache-Control": { - "type": "string", - "description": "If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header." - }, - "Content-Disposition": { - "type": "string", - "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." - }, - "Content-Language": { - "type": "string", - "description": "Returns the value that was specified for the Content-Language request header." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-copy-completion-time": { - "x-ms-client-name": "CopyCompletionTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." - }, - "x-ms-copy-status-description": { - "x-ms-client-name": "CopyStatusDescription", - "type": "string", - "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." - }, - "x-ms-copy-id": { - "x-ms-client-name": "CopyId", - "type": "string", - "description": "String identifier for the last attempted Copy File operation where this file was the destination file." - }, - "x-ms-copy-progress": { - "x-ms-client-name": "CopyProgress", - "type": "string", - "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." - }, - "x-ms-copy-source": { - "x-ms-client-name": "CopySource", - "type": "string", - "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." - }, - "x-ms-copy-status": { - "x-ms-client-name": "CopyStatus", - "description": "State of the copy operation identified by 'x-ms-copy-id'.", - "type": "string", - "enum": [ - "pending", - "success", - "aborted", - "failed" - ], - "x-ms-enum": { - "name": "CopyStatusType", - "modelAsString": false - } - }, - "x-ms-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." - }, - "x-ms-file-attributes": { - "x-ms-client-name": "FileAttributes", - "type": "string", - "description": "Attributes set for the file." - }, - "x-ms-file-creation-time": { - "x-ms-client-name": "FileCreationTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Creation time for the file." - }, - "x-ms-file-last-write-time": { - "x-ms-client-name": "FileLastWriteTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Last write time for the file." - }, - "x-ms-file-change-time": { - "x-ms-client-name": "FileChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Change time for the file." - }, - "x-ms-file-permission-key": { - "x-ms-client-name": "FilePermissionKey", - "type": "string", - "description": "Key of the permission set for the file." - }, - "x-ms-file-id": { - "x-ms-client-name": "FileId", - "type": "string", - "description": "The fileId of the file." - }, - "x-ms-file-parent-id": { - "x-ms-client-name": "FileParentId", - "type": "string", - "description": "The parent fileId of the file." - }, - "x-ms-lease-duration": { - "x-ms-client-name": "LeaseDuration", - "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", - "type": "string", - "enum": [ - "infinite", - "fixed" - ], - "x-ms-enum": { - "name": "LeaseDurationType", - "modelAsString": false - } - }, - "x-ms-lease-state": { - "x-ms-client-name": "LeaseState", - "description": "Lease state of the file.", - "type": "string", - "enum": [ - "available", - "leased", - "expired", - "breaking", - "broken" - ], - "x-ms-enum": { - "name": "LeaseStateType", - "modelAsString": false - } - }, - "x-ms-lease-status": { - "x-ms-client-name": "LeaseStatus", - "description": "The current lease status of the file.", - "type": "string", - "enum": [ - "locked", - "unlocked" - ], - "x-ms-enum": { - "name": "LeaseStatusType", - "modelAsString": false - } - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "delete": { - "tags": [ - "file" - ], - "operationId": "File_Delete", - "description": "removes the file from the storage account.", - "parameters": [{ - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "202": { - "description": "Success (Accepted).", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [ - - ] - }, - "/{shareName}/{directory}/{fileName}?comp=properties": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_SetHTTPHeaders", - "description": "Sets HTTP headers on the file.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "x-ms-content-length", - "x-ms-client-name": "fileContentLength", - "in": "header", - "description": "Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared.", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "$ref": "#/parameters/FileContentType" - }, - { - "$ref": "#/parameters/FileContentEncoding" - }, - { - "$ref": "#/parameters/FileContentLanguage" - }, - { - "$ref": "#/parameters/FileCacheControl" - }, - { - "$ref": "#/parameters/FileContentMD5" - }, - { - "$ref": "#/parameters/FileContentDisposition" - }, - { - "$ref": "#/parameters/FilePermission" - }, - { - "$ref": "#/parameters/FilePermissionKey" - }, - { - "$ref": "#/parameters/FileAttributes" - }, - { - "$ref": "#/parameters/FileCreationTime" - }, - { - "$ref": "#/parameters/FileLastWriteTime" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Success", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the file, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." - }, - "x-ms-file-permission-key": { - "x-ms-client-name": "FilePermissionKey", - "type": "string", - "description": "Key of the permission set for the file." - }, - "x-ms-file-attributes": { - "x-ms-client-name": "FileAttributes", - "type": "string", - "description": "Attributes set for the file." - }, - "x-ms-file-creation-time": { - "x-ms-client-name": "FileCreationTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Creation time for the file." - }, - "x-ms-file-last-write-time": { - "x-ms-client-name": "FileLastWriteTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Last write time for the file." - }, - "x-ms-file-change-time": { - "x-ms-client-name": "FileChangeTime", - "type": "string", - "format": "date-time-rfc1123", - "description": "Change time for the file." - }, - "x-ms-file-id": { - "x-ms-client-name": "FileId", - "type": "string", - "description": "The fileId of the directory." - }, - "x-ms-file-parent-id": { - "x-ms-client-name": "FileParentId", - "type": "string", - "description": "The parent fileId of the directory." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "forceclosehandles" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_Create", + "description": "Creates a new file or replaces a file. Note it only initializes the file with no content.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-content-length", + "x-ms-client-name": "fileContentLength", + "in": "header", + "description": "Specifies the maximum size for the file, up to 4 TB.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "$ref": "#/parameters/FileType" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/FileContentEncoding" + }, + { + "$ref": "#/parameters/FileContentLanguage" + }, + { + "$ref": "#/parameters/FileCacheControl" + }, + { + "$ref": "#/parameters/FileContentMD5" + }, + { + "$ref": "#/parameters/FileContentDisposition" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "201": { + "description": "Success, File created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "file" + ], + "operationId": "File_Download", + "description": "Reads or downloads a file from the system, including its metadata and properties.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/GetRangeContentMD5" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Succeeded to read the entire file.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." + }, + "Content-Encoding": { + "type": "string", + "description": "Returns the value that was specified for the Content-Encoding request header." + }, + "Cache-Control": { + "type": "string", + "description": "Returned if it was previously specified for the file." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", "type": "string", "enum": [ - "properties" - ] - }] - }, - "/{shareName}/{directory}/{fileName}?comp=metadata": { - "put": { - "tags": [ - "file" + "pending", + "success", + "aborted", + "failed" ], - "operationId": "File_SetMetadata", - "description": "Updates user-defined metadata for the specified file.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Metadata" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Success (OK).", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the file, in quotes." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false } - }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, + }, + "x-ms-content-md5": { + "x-ms-client-name": "FileContentMD5", + "type": "string", + "format": "byte", + "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", "type": "string", "enum": [ - "metadata" - ] - }] - }, - "/{shareName}/{directory}/{fileName}?comp=lease&acquire": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_AcquireLease", - "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseDuration" - }, - { - "$ref": "#/parameters/ProposedLeaseIdOptional" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "201": { - "description": "The Acquire operation completed successfully.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." - }, - "x-ms-lease-id": { - "x-ms-client-name": "LeaseId", - "type": "string", - "description": "Uniquely identifies a file's lease" - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "lease" - ] - }, - { - "name": "x-ms-lease-action", - "x-ms-client-name": "action", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "acquire" - ], - "x-ms-enum": { - "name": "LeaseAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Describes what lease action to take." - } - ] - }, - "/{shareName}/{directory}/{fileName}?comp=lease&release": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_ReleaseLease", - "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdRequired" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } + "infinite", + "fixed" ], - "responses": { - "200": { - "description": "The Release operation completed successfully.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "lease" - ] - }, - { - "name": "x-ms-lease-action", - "x-ms-client-name": "action", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "release" - ], - "x-ms-enum": { - "name": "LeaseAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Describes what lease action to take." + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false } - ] - }, - "/{shareName}/{directory}/{fileName}?comp=lease&change": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_ChangeLease", - "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdRequired" - }, - { - "$ref": "#/parameters/ProposedLeaseIdOptional" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" ], - "responses": { - "200": { - "description": "The Change operation completed successfully.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." - }, - "x-ms-lease-id": { - "x-ms-client-name": "LeaseId", - "type": "string", - "description": "Uniquely identifies a file's lease" - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "lease" - ] - }, - { - "name": "x-ms-lease-action", - "x-ms-client-name": "action", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "change" - ], - "x-ms-enum": { - "name": "LeaseAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Describes what lease action to take." + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false } - ] - }, - "/{shareName}/{directory}/{fileName}?comp=lease&break": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_BreakLease", - "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" ], - "responses": { - "202": { - "description": "The Break operation completed successfully.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." - }, - "x-ms-lease-id": { - "x-ms-client-name": "LeaseId", - "type": "string", - "description": "Uniquely identifies a file's lease" - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false } + } }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "lease" - ] - }, - { - "name": "x-ms-lease-action", - "x-ms-client-name": "action", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "break" - ], - "x-ms-enum": { - "name": "LeaseAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Describes what lease action to take." - } - ] - }, - "/{shareName}/{directory}/{fileName}?comp=range": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_UploadRange", - "description": "Upload a range of bytes to a file.", - "consumes": [ - "application/octet-stream" - ], - "parameters": [ - { - "$ref": "#/parameters/OptionalBody" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "name": "x-ms-range", - "x-ms-client-name": "range", - "in": "header", - "description": "Specifies the range of bytes to be written. Both the start and end of the range must be specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the range can be up to the value of the file's full size. The File service accepts only a single byte range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following format: bytes=startByte-endByte.", - "required": true, - "type": "string" - }, - { - "name": "x-ms-write", - "x-ms-client-name": "FileRangeWrite", - "in": "header", - "description": "Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and set the Range header to a value that indicates the range to clear, up to maximum file size.", - "required": true, - "type": "string", - "enum": [ - "update", - "clear" - ], - "default": "update", - "x-ms-enum": { - "name": "FileRangeWriteType", - "modelAsString": false - } - }, - { - "$ref": "#/parameters/ContentLength" - }, - { - "$ref": "#/parameters/ContentMD5" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } + "schema": { + "type": "object", + "format": "file" + } + }, + "206": { + "description": "Succeeded to read a specified range of the file.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." + }, + "Content-Encoding": { + "type": "string", + "description": "Returns the value that was specified for the Content-Encoding request header." + }, + "Cache-Control": { + "type": "string", + "description": "Returned if it was previously specified for the file." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" ], - "responses": { - "201": { - "description": "Success (Created).", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the file, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "Content-MD5": { - "type": "string", - "format": "byte", - "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false } - }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, + }, + "x-ms-content-md5": { + "x-ms-client-name": "FileContentMD5", + "type": "string", + "format": "byte", + "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", "type": "string", "enum": [ - "range" - ] - }] - }, - "/{shareName}/{directory}/{fileName}?comp=range&fromURL": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_UploadRangeFromURL", - "description": "Upload a range of bytes to a file where the contents are read from a URL.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/TargetRange" - }, - { - "$ref": "#/parameters/CopySource" - }, - { - "$ref": "#/parameters/SourceRange" - }, - { - "$ref": "#/parameters/FileRangeWriteFromUrl" - }, - { - "$ref": "#/parameters/ContentLength" - }, - { - "$ref": "#/parameters/SourceContentCrc64" - }, - { - "$ref": "#/parameters/SourceIfMatchCrc64" - }, - { - "$ref": "#/parameters/SourceIfNoneMatchCrc64" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/CopySourceAuthorization" - } + "infinite", + "fixed" ], - "responses": { - "201": { - "description": "Success (Created).", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the file, in quotes." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." - }, - "x-ms-content-crc64": { - "type": "string", - "format": "byte", - "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false } - }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", "type": "string", "enum": [ - "range" - ] - }] - }, - "/{shareName}/{directory}/{fileName}?comp=rangelist": { - "get": { - "tags": [ - "file" + "available", + "leased", + "expired", + "breaking", + "broken" ], - "operationId": "File_GetRangeList", - "description": "Returns the list of valid ranges for a file.", - "parameters": [{ - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/PrevShareSnapshot" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "x-ms-range", - "x-ms-client-name": "range", - "in": "header", - "description": "Specifies the range of bytes over which to list ranges, inclusively.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "The date/time that the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the file's last modified time." - }, - "ETag": { - "type": "string", - "format": "etag", - "description": "The ETag contains a value which represents the version of the file, in quotes." - }, - "x-ms-content-length": { - "x-ms-client-name": "FileContentLength", - "type": "integer", - "format": "int64", - "description": "The size of the file in bytes." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - }, - "schema": { - "$ref": "#/definitions/ShareFileRangeList" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false } - }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", "type": "string", "enum": [ - "rangelist" - ] - }] - }, - "/{shareName}/{directory}/{fileName}?comp=copy": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_StartCopy", - "description": "Copies a blob or file to a destination file within the storage account.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/Metadata" - }, - { - "$ref": "#/parameters/CopySource" - }, - { - "$ref": "#/parameters/FilePermission" - }, - { - "$ref": "#/parameters/FilePermissionKey" - }, - { - "$ref": "#/parameters/FileCopyPermissionCopyMode" - }, - { - "$ref": "#/parameters/FileCopyIgnoreReadOnly" - }, - { - "$ref": "#/parameters/FileCopyFileAttributes" - }, - { - "$ref": "#/parameters/FileCopyFileCreationTime" - }, - { - "$ref": "#/parameters/FileCopyFileLastWriteTime" - }, - { - "$ref": "#/parameters/FileCopySetArchiveAttribute" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } + "locked", + "unlocked" ], - "responses": { - "202": { - "description": "The copy file has been accepted with the specified copy status.", - "headers": { - "ETag": { - "type": "string", - "format": "etag", - "description": "If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy." - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date/time that the copy operation to the destination file completed." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-copy-id": { - "x-ms-client-name": "CopyId", - "type": "string", - "description": "String identifier for this copy operation. Use with Get File or Get File Properties to check the status of this copy operation, or pass to Abort Copy File to abort a pending copy." - }, - "x-ms-copy-status": { - "x-ms-client-name": "CopyStatus", - "description": "State of the copy operation identified by x-ms-copy-id.", - "type": "string", - "enum": [ - "pending", - "success", - "aborted", - "failed" - ], - "x-ms-enum": { - "name": "CopyStatusType", - "modelAsString": false - } - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false } + } }, - "parameters": [ - - ] - }, - "/{shareName}/{directory}/{fileName}?comp=copy©id={CopyId}": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_AbortCopy", - "description": "Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata.", - "parameters": [ - { - "$ref": "#/parameters/CopyId" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/CopyActionAbort" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - } - ], - "responses": { - "204": { - "description": "The delete request was accepted and the file will be deleted.", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "head": { + "tags": [ + "file" + ], + "operationId": "File_GetProperties", + "description": "Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-type": { + "x-ms-client-name": "FileType", + "description": "Returns the type File. Reserved for future use.", "type": "string", "enum": [ - "copy" + "File" ] - }] - }, - "/{shareName}/{directory}/{fileName}?comp=listhandles": { - "get":{ - "tags": [ - "file" - ], - "operationId": "File_ListHandles", - "description": "Lists handles for file", - "parameters":[ - { - "$ref": "#/parameters/Marker" - }, - { - "$ref": "#/parameters/MaxResults" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header." + }, + "Cache-Control": { + "type": "string", + "description": "If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "Content-Type": { - "type": "string", - "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - } - }, - "schema": { - "$ref": "#/definitions/ListHandlesResponse" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "listhandles" - ] + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false } - ] - }, - "/{shareName}/{directory}/{fileName}?comp=forceclosehandles": { - "put": { - "tags": [ - "file" - ], - "operationId": "File_ForceCloseHandles", - "description": "Closes all handles open for given file", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Marker" - }, - { - "$ref": "#/parameters/ShareSnapshot" - }, - { - "$ref": "#/parameters/HandleId" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the File service used to execute the request." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." - }, - "x-ms-marker": { - "x-ms-client-name": "marker", - "type": "string", - "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." - }, - "x-ms-number-of-handles-closed": { - "x-ms-client-name": "numberOfHandlesClosed", - "type": "integer", - "description": "Contains count of number of handles closed." - }, - "x-ms-number-of-handles-failed": { - "x-ms-client-name": "numberOfHandlesFailedToClose", - "type": "integer", - "description": "Contains count of number of handles that failed to close." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false } - }, - "parameters": [{ - "name": "comp", - "in": "query", - "required": true, + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", "type": "string", "enum": [ - "forceclosehandles" - ] - } - ] - } - }, - "definitions": { - "AccessPolicy": { - "description": "An Access policy.", - "type": "object", - "properties": { - "Start": { - "description": "The date-time the policy is active.", - "type": "string", - "format": "date-time" - }, - "Expiry": { - "description": "The date-time the policy expires.", - "type": "string", - "format": "date-time" - }, - "Permission": { - "description": "The permissions for the ACL policy.", - "type": "string" - } - } - }, - "CorsRule": { - "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.", - "type": "object", - "required": [ - "AllowedOrigins", - "AllowedMethods", - "AllowedHeaders", - "ExposedHeaders", - "MaxAgeInSeconds" - ], - "properties": { - "AllowedOrigins": { - "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", - "type": "string" - }, - "AllowedMethods": { - "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", - "type": "string" - }, - "AllowedHeaders": { - "description": "The request headers that the origin domain may specify on the CORS request.", - "type": "string" - }, - "ExposedHeaders": { - "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.", - "type": "string" - }, - "MaxAgeInSeconds": { - "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", - "type": "integer", - "minimum": 0 - } - } - }, - "ErrorCode": { - "description": "Error codes returned by the service", - "type": "string", - "enum": [ - "AccountAlreadyExists", - "AccountBeingCreated", - "AccountIsDisabled", - "AuthenticationFailed", - "AuthorizationFailure", - "ConditionHeadersNotSupported", - "ConditionNotMet", - "EmptyMetadataKey", - "InsufficientAccountPermissions", - "InternalError", - "InvalidAuthenticationInfo", - "InvalidHeaderValue", - "InvalidHttpVerb", - "InvalidInput", - "InvalidMd5", - "InvalidMetadata", - "InvalidQueryParameterValue", - "InvalidRange", - "InvalidResourceName", - "InvalidUri", - "InvalidXmlDocument", - "InvalidXmlNodeValue", - "Md5Mismatch", - "MetadataTooLarge", - "MissingContentLengthHeader", - "MissingRequiredQueryParameter", - "MissingRequiredHeader", - "MissingRequiredXmlNode", - "MultipleConditionHeadersNotSupported", - "OperationTimedOut", - "OutOfRangeInput", - "OutOfRangeQueryParameterValue", - "RequestBodyTooLarge", - "ResourceTypeMismatch", - "RequestUrlFailedToParse", - "ResourceAlreadyExists", - "ResourceNotFound", - "ServerBusy", - "UnsupportedHeader", - "UnsupportedXmlNode", - "UnsupportedQueryParameter", - "UnsupportedHttpVerb", - "CannotDeleteFileOrDirectory", - "ClientCacheFlushDelay", - "DeletePending", - "DirectoryNotEmpty", - "FileLockConflict", - "InvalidFileOrDirectoryPathName", - "ParentNotFound", - "ReadOnlyAttribute", - "ShareAlreadyExists", - "ShareBeingDeleted", - "ShareDisabled", - "ShareNotFound", - "SharingViolation", - "ShareSnapshotInProgress", - "ShareSnapshotCountExceeded", - "ShareSnapshotOperationNotSupported", - "ShareHasSnapshots", - "ContainerQuotaDowngradeNotAllowed", - "AuthorizationSourceIPMismatch", - "AuthorizationProtocolMismatch", - "AuthorizationPermissionMismatch", - "AuthorizationServiceMismatch", - "AuthorizationResourceTypeMismatch", - "FeatureVersionMismatch" - ], - "x-ms-enum": { - "name": "StorageErrorCode", - "modelAsString": true - } - }, - "FilesAndDirectoriesListSegment": { - "description": "Abstract for entries that can be listed from Directory.", - "type": "object", - "required": [ - "DirectoryItems", - "FileItems" - ], - "properties": { - "DirectoryItems": { - "type": "array", - "items": { - "$ref": "#/definitions/DirectoryItem" - } - }, - "FileItems": { - "type": "array", - "items": { - "$ref": "#/definitions/FileItem" - } + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false } - }, - "xml": { - "name": "Entries" - } - }, - "DirectoryItem": { - "xml": { - "name": "Directory" - }, - "description": "A listed directory item.", - "type": "object", - "required": [ - "Name" - ], - "properties": { - "Name": { - "type": "string" - }, - "FileId": { - "type": "string" - }, - "Properties": { - "$ref": "#/definitions/FileProperty" - }, - "Attributes": { - "type": "string" - }, - "PermissionKey": { - "type": "string" + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false } + } } - }, - "FileItem": { - "xml": { - "name": "File" + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "description": "A listed file item.", - "type": "object", - "required": [ - "Name", - "Properties" - ], - "properties": { - "Name": { - "type": "string" - }, - "FileId": { - "type": "string" - }, - "Properties": { - "$ref": "#/definitions/FileProperty" - }, - "Attributes": { - "type": "string" - }, - "PermissionKey": { - "type": "string" - } + "schema": { + "$ref": "#/definitions/StorageError" } - }, - "FileProperty": { - "description": "File properties.", - "type": "object", - "required": [ - "Content-Length" - ], - "properties": { - "Content-Length": { - "description": "Content length of the file. This value may not be up-to-date since an SMB client may have modified the file locally. The value of Content-Length may not reflect that fact until the handle is closed or the op-lock is broken. To retrieve current property values, call Get File Properties.", - "type": "integer", - "format": "int64" - }, - "CreationTime": { - "type": "string", - "format": "date-time" - }, - "LastAccessTime": { - "type": "string", - "format": "date-time" - }, - "LastWriteTime": { - "type": "string", - "format": "date-time" - }, - "ChangeTime": { - "type": "string", - "format": "date-time" - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123" - }, - "Etag": { - "type": "string", - "format": "etag" - } + } + } + }, + "delete": { + "tags": [ + "file" + ], + "operationId": "File_Delete", + "description": "removes the file from the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "202": { + "description": "Success (Accepted).", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } } - }, - "HandleItem" : { - "xml": { - "name": "Handle" + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "description": "A listed Azure Storage handle item.", - "type": "object", - "required": [ - "HandleId", - "Path", - "FileId", - "SessionId", - "ClientIp", - "OpenTime" - ], - "properties": { - "HandleId": { - "type": "string", - "description": "XSMB service handle ID" - }, - "Path": { - "type": "string", - "description": "File or directory name including full path starting from share root" - }, - "FileId": { - "type": "string", - "description": "FileId uniquely identifies the file or directory." - }, - "ParentId": { - "type": "string", - "description": "ParentId uniquely identifies the parent directory of the object." - }, - "SessionId": { - "type": "string", - "description": "SMB session ID in context of which the file handle was opened" - }, - "ClientIp": { - "type": "string", - "description": "Client IP that opened the handle" - }, - "OpenTime": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Time when the session that previously opened the handle has last been reconnected. (UTC)" - }, - "LastReconnectTime": { - "type": "string", - "format": "date-time-rfc1123", - "description": "Time handle was last connected to (UTC)" - } + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "LeaseDuration": { - "xml": { - "name": "LeaseDuration" - }, - "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", - "type": "string", - "enum": [ - "infinite", - "fixed" - ], - "x-ms-enum": { - "name": "LeaseDurationType", - "modelAsString": false - } + { + "$ref": "#/parameters/DirectoryPath" }, - "LeaseState": { - "xml": { - "name": "LeaseState" - }, - "description": "Lease state of the share.", - "type": "string", - "enum": [ - "available", - "leased", - "expired", - "breaking", - "broken" - ], - "x-ms-enum": { - "name": "LeaseStateType", - "modelAsString": false + { + "$ref": "#/parameters/FilePath" + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=properties": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_SetHTTPHeaders", + "description": "Sets HTTP headers on the file.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-content-length", + "x-ms-client-name": "fileContentLength", + "in": "header", + "description": "Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/FileContentEncoding" + }, + { + "$ref": "#/parameters/FileContentLanguage" + }, + { + "$ref": "#/parameters/FileCacheControl" + }, + { + "$ref": "#/parameters/FileContentMD5" + }, + { + "$ref": "#/parameters/FileContentDisposition" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } } - }, - "LeaseStatus": { - "xml": { - "name": "LeaseStatus" + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "description": "The current lease status of the share.", - "type": "string", - "enum": [ - "locked", - "unlocked" - ], - "x-ms-enum": { - "name": "LeaseStatusType", - "modelAsString": false + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "ListFilesAndDirectoriesSegmentResponse": { - "xml": { - "name": "EnumerationResults" - }, - "description": "An enumeration of directories and files.", - "type": "object", - "required": [ - "ServiceEndpoint", - "ShareName", - "DirectoryPath", - "Prefix", - "NextMarker", - "Segment" - ], - "properties": { - "ServiceEndpoint": { - "type": "string", - "xml": { - "attribute": true - } - }, - "ShareName": { - "type": "string", - "xml": { - "attribute": true - } - }, - "ShareSnapshot": { - "type": "string", - "xml": { - "attribute": true - } - }, - "DirectoryPath": { - "type": "string", - "xml": { - "attribute": true - } - }, - "Prefix": { - "type": "string" - }, - "Marker": { - "type": "string" - }, - "MaxResults": { - "type": "integer" - }, - "Segment": { - "$ref": "#/definitions/FilesAndDirectoriesListSegment" - }, - "NextMarker": { - "type": "string" - }, - "DirectoryId": { - "type": "string" - } - } + { + "$ref": "#/parameters/DirectoryPath" }, - "ListHandlesResponse": { - "xml": { - "name": "EnumerationResults" - }, - "description": "An enumeration of handles.", - "type": "object", - "required": [ - "NextMarker" - ], - "properties": { - "HandleList": { - "type": "array", - "items": { - "$ref": "#/definitions/HandleItem" - }, - "xml": { - "name": "Entries", - "wrapped": true - } - }, - "NextMarker": { - "type": "string" - } - } + { + "$ref": "#/parameters/FilePath" }, - "ListSharesResponse": { - "xml": { - "name": "EnumerationResults" - }, - "description": "An enumeration of shares.", - "type": "object", - "required": [ - "ServiceEndpoint", - "NextMarker" - ], - "properties": { - "ServiceEndpoint": { - "type": "string", - "xml": { - "attribute": true - } - }, - "Prefix": { - "type": "string" - }, - "Marker": { - "type": "string" - }, - "MaxResults": { - "type": "integer" - }, - "ShareItems": { - "type": "array", - "items": { - "$ref": "#/definitions/ShareItemInternal" - }, - "xml": { - "name": "Shares", - "wrapped": true - } - }, - "NextMarker": { - "type": "string" - } + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=metadata": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_SetMetadata", + "description": "Updates user-defined metadata for the specified file.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success (OK).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } } - }, - "Metadata": { - "type": "object", - "additionalProperties": { + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "Metrics": { - "description": "Storage Analytics metrics for file service.", - "required": [ - "Version", - "Enabled" - ], - "properties": { - "Version": { - "description": "The version of Storage Analytics to configure.", - "type": "string" - }, - "Enabled": { - "description": "Indicates whether metrics are enabled for the File service.", - "type": "boolean" - }, - "IncludeAPIs": { - "description": "Indicates whether metrics should generate summary statistics for called API operations.", - "type": "boolean" - }, - "RetentionPolicy": { - "$ref": "#/definitions/RetentionPolicy" - } - } + { + "$ref": "#/parameters/DirectoryPath" }, - "SmbMultichannel": { - "description": "Settings for SMB multichannel", - "type": "object", - "properties": { - "Enabled": { - "type": "boolean", - "description": "If SMB multichannel is enabled." - } - }, - "xml": { - "name": "Multichannel" - } + { + "$ref": "#/parameters/FilePath" }, - "FileRange": { - "description": "An Azure Storage file range.", - "type": "object", - "required": [ - "Start", - "End" - ], - "properties": { - "Start": { - "type": "integer", - "format": "int64", - "description": "Start of the range." - }, - "End": { - "type": "integer", - "format": "int64", - "description": "End of the range." - } - }, - "xml": { - "name": "Range" + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&acquire": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_AcquireLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } - }, - "ClearRange": { - "type": "object", - "required": [ - "Start", - "End" - ], - "properties": { - "Start": { - "type": "integer", - "format": "int64", - "xml": { - "name": "Start" - } - }, - "End": { - "type": "integer", - "format": "int64", - "xml": { - "name": "End" - } - } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "xml": { - "name": "ClearRange" + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "ShareProtocolSettings": { - "description": "Protocol settings", - "type": "object", - "xml": { - "name": "ProtocolSettings" - }, - "properties": { - "Smb": { - "description": "Settings for SMB protocol.", - "$ref": "#/definitions/ShareSmbSettings" - } - } + { + "$ref": "#/parameters/DirectoryPath" }, - "ShareFileRangeList": { - "description": "The list of file ranges", - "type": "object", - "properties": { - "Ranges": { - "type": "array", - "items": { - "$ref": "#/definitions/FileRange" - } - }, - "ClearRanges": { - "type": "array", - "items": { - "$ref": "#/definitions/ClearRange" - } - } - } + { + "$ref": "#/parameters/FilePath" }, - "StorageError": { - "type": "object", - "properties": { - "Message": { - "type": "string" - } - } + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] }, - "RetentionPolicy": { - "description": "The retention policy.", - "type": "object", - "required": [ - "Enabled" - ], - "properties": { - "Enabled": { - "description": "Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it.", - "type": "boolean" - }, - "Days": { - "description": "Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires.", - "type": "integer", - "minimum": 1, - "maximum": 365 - } + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&release": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ReleaseLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } - }, - "ShareItemInternal": { - "xml": { - "name": "Share" + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "description": "A listed Azure Storage share item.", - "type": "object", - "required": [ - "Name", - "Properties" - ], - "properties": { - "Name": { - "type": "string" - }, - "Snapshot": { - "type": "string" - }, - "Deleted": { - "type": "boolean" - }, - "Version": { - "type": "string" - }, - "Properties": { - "$ref": "#/definitions/SharePropertiesInternal" - }, - "Metadata": { - "$ref": "#/definitions/Metadata" - } + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "SharePropertiesInternal": { - "description": "Properties of a share.", - "type": "object", - "required": [ - "Last-Modified", - "Etag", - "Quota" - ], - "properties": { - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123" - }, - "Etag": { - "type": "string", - "format": "etag" - }, - "Quota": { - "type": "integer" - }, - "ProvisionedIops": { - "type": "integer" - }, - "ProvisionedIngressMBps": { - "type": "integer" - }, - "ProvisionedEgressMBps": { - "type": "integer" - }, - "NextAllowedQuotaDowngradeTime": { - "type": "string", - "format": "date-time-rfc1123" - }, - "DeletedTime": { - "type": "string", - "format": "date-time-rfc1123" - }, - "RemainingRetentionDays": { - "type": "integer" - }, - "AccessTier": { - "type": "string" - }, - "AccessTierChangeTime": { - "type": "string", - "format": "date-time-rfc1123" - }, - "AccessTierTransitionState": { - "type": "string" - }, - "LeaseStatus": { - "$ref": "#/definitions/LeaseStatus" - }, - "LeaseState": { - "$ref": "#/definitions/LeaseState" - }, - "LeaseDuration": { - "$ref": "#/definitions/LeaseDuration" - }, - "EnabledProtocols": { - "$ref": "#/definitions/ShareEnabledProtocols" - }, - "RootSquash": { - "$ref": "#/definitions/ShareRootSquash" - } - } + { + "$ref": "#/parameters/DirectoryPath" }, - "ShareStats": { - "description": "Stats for the share.", - "type": "object", - "required": [ - "ShareUsageBytes" - ], - "properties": { - "ShareUsageBytes": { - "description": "The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files.", - "type": "integer" - } - } + { + "$ref": "#/parameters/FilePath" }, - "SignedIdentifier": { - "description": "Signed identifier.", - "type": "object", - "required": [ - "Id" - ], - "properties": { - "Id": { - "type": "string", - "description": "A unique id." - }, - "AccessPolicy": { - "description": "The access policy.", - "$ref": "#/definitions/AccessPolicy" - } - } + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] }, - "SignedIdentifiers": { - "description": "A collection of signed identifiers.", - "type": "array", - "items": { - "$ref": "#/definitions/SignedIdentifier", - "xml": { - "name": "SignedIdentifier" - } - }, - "xml": { - "wrapped": true, - "name": "SignedIdentifiers" + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&change": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ChangeLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } - }, - "ShareSmbSettings": { - "description": "Settings for SMB protocol.", - "type": "object", - "xml": { - "name": "SMB" + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "properties": { - "Multichannel": { - "description": "Settings for SMB Multichannel.", - "$ref": "#/definitions/SmbMultichannel" - } + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "StorageServiceProperties": { - "description": "Storage service properties.", - "type": "object", - "properties": { - "HourMetrics": { - "description": "A summary of request statistics grouped by API in hourly aggregates for files.", - "$ref": "#/definitions/Metrics" - }, - "MinuteMetrics": { - "description": "A summary of request statistics grouped by API in minute aggregates for files.", - "$ref": "#/definitions/Metrics" - }, - "Cors": { - "description": "The set of CORS rules.", - "type": "array", - "items": { - "$ref": "#/definitions/CorsRule" - }, - "xml": { - "wrapped": true - } - }, - "Protocol": { - "description": "Protocol settings", - "$ref":"#/definitions/ShareProtocolSettings" - } - } + { + "$ref": "#/parameters/DirectoryPath" }, - "SharePermission": { - "description": "A permission (a security descriptor) at the share level.", - "type": "object", - "required": [ - "permission" - ], - "properties": { - "permission": { - "type": "string", - "description": "The permission in the Security Descriptor Definition Language (SDDL)." - } - } + { + "$ref": "#/parameters/FilePath" }, - "ShareEnabledProtocols": { - "type": "string" + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] }, - "ShareRootSquash": { - "type": "string", - "enum": [ - "NoRootSquash", - "RootSquash", - "AllSquash" - ], - "x-ms-enum": { - "name": "ShareRootSquash", - "modelAsString": false - } + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." } + ] }, - "parameters": { - "AccessTierOptional": { - "name": "x-ms-access-tier", - "x-ms-client-name": "accessTier", - "in": "header", - "description": "Specifies the access tier of the share.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "enum": [ - "TransactionOptimized", - "Hot", - "Cool" - ], - "x-ms-enum": { - "name": "ShareAccessTier", - "modelAsString": true + "/{shareName}/{directory}/{fileName}?comp=lease&break": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_BreakLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "ApiVersionParameter": { - "name": "x-ms-version", - "x-ms-client-name": "version", - "in": "header", - "description": "Specifies the version of the operation to use for this request.", - "required": true, - "type": "string", - "enum": [ - "2020-10-02" - ] + { + "$ref": "#/parameters/DirectoryPath" }, - "ClientRequestId": { - "name": "x-ms-client-request-id", - "x-ms-client-name": "requestId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + { + "$ref": "#/parameters/FilePath" }, - "ContentLength": { - "name": "Content-Length", - "x-ms-client-name": "contentLength", - "in": "header", - "description": "Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero.", - "required": true, - "type": "integer", - "format": "int64", - "x-ms-parameter-location": "method" + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] }, - "ContentMD5": { - "name": "Content-MD5", - "x-ms-client-name": "contentMD5", + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=range": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_UploadRange", + "description": "Upload a range of bytes to a file.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/OptionalBody" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "name": "x-ms-range", + "x-ms-client-name": "range", "in": "header", - "description": "An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request).", - "required": false, - "type": "string", - "format": "byte", - "x-ms-parameter-location": "method" - }, - "CopyActionAbort": { - "name": "x-ms-copy-action", - "x-ms-client-name": "copyActionAbortConstant", + "description": "Specifies the range of bytes to be written. Both the start and end of the range must be specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the range can be up to the value of the file's full size. The File service accepts only a single byte range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following format: bytes=startByte-endByte.", + "required": true, + "type": "string" + }, + { + "name": "x-ms-write", + "x-ms-client-name": "FileRangeWrite", "in": "header", + "description": "Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and set the Range header to a value that indicates the range to clear, up to maximum file size.", "required": true, "type": "string", "enum": [ - "abort" + "update", + "clear" ], - "x-ms-parameter-location": "method" + "default": "update", + "x-ms-enum": { + "name": "FileRangeWriteType", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "201": { + "description": "Success (Created).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "CopyId": { - "name": "copyid", - "x-ms-client-name": "copyId", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy File operation." + { + "$ref": "#/parameters/DirectoryPath" }, - "CopySource": { - "name": "x-ms-copy-source", - "x-ms-client-name": "copySource", - "in": "header", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source." + { + "$ref": "#/parameters/FilePath" }, - "CopySourceAuthorization": { - "name": "x-ms-copy-source-authorization", - "x-ms-client-name": "copySourceAuthorization", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source." + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "range" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=range&fromURL": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_UploadRangeFromURL", + "description": "Upload a range of bytes to a file where the contents are read from a URL.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/TargetRange" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/SourceRange" + }, + { + "$ref": "#/parameters/FileRangeWriteFromUrl" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/SourceContentCrc64" + }, + { + "$ref": "#/parameters/SourceIfMatchCrc64" + }, + { + "$ref": "#/parameters/SourceIfNoneMatchCrc64" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + } + ], + "responses": { + "201": { + "description": "Success (Created).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" }, - "FileCopyPermissionCopyMode": { - "name": "x-ms-file-permission-copy-mode", - "x-ms-client-name": "filePermissionCopyMode", + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "range" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=rangelist": { + "get": { + "tags": [ + "file" + ], + "operationId": "File_GetRangeList", + "description": "Returns the list of valid ranges for a file.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/PrevShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-range", + "x-ms-client-name": "range", "in": "header", + "description": "Specifies the range of bytes over which to list ranges, inclusively.", "required": false, - "type": "string", - "enum": [ - "source", - "override" - ], - "x-ms-enum": { - "name": "PermissionCopyModeType", - "modelAsString": false + "type": "string" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "The date/time that the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the file's last modified time." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-content-length": { + "x-ms-client-name": "FileContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the file in bytes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } }, - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "copy-file-smb-info" + "schema": { + "$ref": "#/definitions/ShareFileRangeList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "description": "Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key." + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "FileCopyIgnoreReadOnly": { - "name": "x-ms-file-copy-ignore-read-only", - "x-ms-client-name": "ignoreReadOnly", - "in": "header", - "required": false, - "type": "boolean", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "copy-file-smb-info" - }, - "description": "Specifies the option to overwrite the target file if it already exists and has read-only attribute set." + { + "$ref": "#/parameters/DirectoryPath" }, - "FileCopyFileAttributes": { - "name": "x-ms-file-attributes", - "x-ms-client-name": "fileAttributes", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "copy-file-smb-info" - }, - "description": "Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file." + { + "$ref": "#/parameters/FilePath" }, - "FileCopyFileCreationTime": { - "name": "x-ms-file-creation-time", - "x-ms-client-name": "fileCreationTime", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "copy-file-smb-info" + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rangelist" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=copy": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_StartCopy", + "description": "Copies a blob or file to a destination file within the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileCopyPermissionCopyMode" + }, + { + "$ref": "#/parameters/FileCopyIgnoreReadOnly" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopySetArchiveAttribute" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "202": { + "description": "The copy file has been accepted with the specified copy status.", + "headers": { + "ETag": { + "type": "string", + "description": "If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date/time that the copy operation to the destination file completed." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get File or Get File Properties to check the status of this copy operation, or pass to Abort Copy File to abort a pending copy." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "description": "Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file." + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "FileCopyFileLastWriteTime": { - "name": "x-ms-file-last-write-time", - "x-ms-client-name": "fileLastWriteTime", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "copy-file-smb-info" - }, - "description": "Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file." + { + "$ref": "#/parameters/DirectoryPath" }, - "FileCopySetArchiveAttribute": { - "name": "x-ms-file-copy-set-archive", - "x-ms-client-name": "setArchiveAttribute", - "in": "header", - "required": false, - "type": "boolean", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "copy-file-smb-info" + { + "$ref": "#/parameters/FilePath" + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=copy©id": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_AbortCopy", + "description": "Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata.", + "parameters": [ + { + "$ref": "#/parameters/CopyId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/CopyActionAbort" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "204": { + "description": "The delete request was accepted and the file will be deleted.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "description": "Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state." + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "DeletedShareName": { - "name": "x-ms-deleted-share-name", - "x-ms-client-name": "DeletedShareName", - "description": "Specifies the name of the preivously-deleted share.", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + { + "$ref": "#/parameters/DirectoryPath" }, - "DeletedShareVersion": { - "name": "x-ms-deleted-share-version", - "x-ms-client-name": "DeletedShareVersion", - "description": "Specifies the version of the preivously-deleted share.", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + { + "$ref": "#/parameters/FilePath" }, - "DeleteSnapshots": { - "name": "x-ms-delete-snapshots", - "x-ms-client-name": "deleteSnapshots", - "description": "Specifies the option include to delete the base share and all of its snapshots.", - "in": "header", - "required": false, - "type": "string", - "enum": [ - "include", - "include-leased" - ], - "x-ms-enum": { - "name": "DeleteSnapshotsOptionType", - "modelAsString": false + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "copy" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=listhandles": { + "get": { + "tags": [ + "file" + ], + "operationId": "File_ListHandles", + "description": "Lists handles for file", + "parameters": [ + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } }, - "x-ms-parameter-location": "method" - }, - "FileAttributes": { - "name": "x-ms-file-attributes", - "x-ms-client-name": "FileAttributes", - "in": "header", - "description": "If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "FileCacheControl": { - "name": "x-ms-cache-control", - "x-ms-client-name": "fileCacheControl", - "description": "Sets the file's cache control. The File service stores this value but does not use or modify it.", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "file-HTTP-headers" + "schema": { + "$ref": "#/definitions/ListHandlesResponse" } - }, - "FileContentDisposition": { - "name": "x-ms-content-disposition", - "x-ms-client-name": "fileContentDisposition", - "description": "Sets the file's Content-Disposition header.", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "file-HTTP-headers" + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "FileContentEncoding": { - "name": "x-ms-content-encoding", - "x-ms-client-name": "fileContentEncoding", - "in": "header", - "description": "Specifies which content encodings have been applied to the file.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "file-HTTP-headers" - } + { + "$ref": "#/parameters/DirectoryPath" }, - "FileContentLanguage": { - "name": "x-ms-content-language", - "x-ms-client-name": "fileContentLanguage", - "in": "header", - "description": "Specifies the natural languages used by this resource.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "file-HTTP-headers" - } + { + "$ref": "#/parameters/FilePath" }, - "FileContentMD5": { - "name": "x-ms-content-md5", - "x-ms-client-name": "fileContentMD5", - "in": "header", - "description": "Sets the file's MD5 hash.", - "required": false, - "type": "string", - "format": "byte", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "file-HTTP-headers" + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "listhandles" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=forceclosehandles": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ForceCloseHandles", + "description": "Closes all handles open for given file", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/HandleId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-marker": { + "x-ms-client-name": "marker", + "type": "string", + "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." + }, + "x-ms-number-of-handles-closed": { + "x-ms-client-name": "numberOfHandlesClosed", + "type": "integer", + "description": "Contains count of number of handles closed." + }, + "x-ms-number-of-handles-failed": { + "x-ms-client-name": "numberOfHandlesFailedToClose", + "type": "integer", + "description": "Contains count of number of handles that failed to close." + } } - }, - "FileContentType": { - "name": "x-ms-content-type", - "x-ms-client-name": "fileContentType", - "in": "header", - "description": "Sets the MIME content type of the file. The default type is 'application/octet-stream'.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "file-HTTP-headers" + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" }, - "FileCreationTime": { - "name": "x-ms-file-creation-time", - "x-ms-client-name": "FileCreationTime", - "in": "header", - "description": "Creation time for the file/directory. Default value: Now.", - "required": true, - "type": "string", - "format": "date-time-rfc1123", - "x-ms-parameter-location": "method" + { + "$ref": "#/parameters/DirectoryPath" }, - "FileLastWriteTime": { - "name": "x-ms-file-last-write-time", - "x-ms-client-name": "FileLastWriteTime", - "in": "header", - "description": "Last write time for the file/directory. Default value: Now.", - "required": true, - "type": "string", - "format": "date-time-rfc1123", - "x-ms-parameter-location": "method" + { + "$ref": "#/parameters/FilePath" }, - "FilePermission": { - "name": "x-ms-file-permission", - "x-ms-client-name": "FilePermission", - "in": "header", - "description": "If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "forceclosehandles" + ] + } + ] + } + }, + "definitions": { + "AccessPolicy": { + "description": "An Access policy.", + "type": "object", + "properties": { + "Start": { + "description": "The date-time the policy is active.", + "type": "string", + "format": "date-time" }, - "FilePermissionKey": { - "name": "x-ms-file-permission-key", - "x-ms-client-name": "FilePermissionKey", - "in": "header", - "description": "Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + "Expiry": { + "description": "The date-time the policy expires.", + "type": "string", + "format": "date-time" }, - "FilePermissionKeyRequired": { - "name": "x-ms-file-permission-key", - "x-ms-client-name": "FilePermissionKey", - "in": "header", - "description": "Key of the permission to be set for the directory/file.", - "required": true, + "Permission": { + "description": "The permissions for the ACL policy.", + "type": "string" + } + } + }, + "CorsRule": { + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" + ], + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string" + }, + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string" + }, + "AllowedHeaders": { + "description": "The request headers that the origin domain may specify on the CORS request.", + "type": "string" + }, + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.", + "type": "string" + }, + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0 + } + } + }, + "ErrorCode": { + "description": "Error codes returned by the service", + "type": "string", + "enum": [ + "AccountAlreadyExists", + "AccountBeingCreated", + "AccountIsDisabled", + "AuthenticationFailed", + "AuthorizationFailure", + "ConditionHeadersNotSupported", + "ConditionNotMet", + "EmptyMetadataKey", + "InsufficientAccountPermissions", + "InternalError", + "InvalidAuthenticationInfo", + "InvalidHeaderValue", + "InvalidHttpVerb", + "InvalidInput", + "InvalidMd5", + "InvalidMetadata", + "InvalidQueryParameterValue", + "InvalidRange", + "InvalidResourceName", + "InvalidUri", + "InvalidXmlDocument", + "InvalidXmlNodeValue", + "Md5Mismatch", + "MetadataTooLarge", + "MissingContentLengthHeader", + "MissingRequiredQueryParameter", + "MissingRequiredHeader", + "MissingRequiredXmlNode", + "MultipleConditionHeadersNotSupported", + "OperationTimedOut", + "OutOfRangeInput", + "OutOfRangeQueryParameterValue", + "RequestBodyTooLarge", + "ResourceTypeMismatch", + "RequestUrlFailedToParse", + "ResourceAlreadyExists", + "ResourceNotFound", + "ServerBusy", + "UnsupportedHeader", + "UnsupportedXmlNode", + "UnsupportedQueryParameter", + "UnsupportedHttpVerb", + "CannotDeleteFileOrDirectory", + "ClientCacheFlushDelay", + "DeletePending", + "DirectoryNotEmpty", + "FileLockConflict", + "InvalidFileOrDirectoryPathName", + "ParentNotFound", + "ReadOnlyAttribute", + "ShareAlreadyExists", + "ShareBeingDeleted", + "ShareDisabled", + "ShareNotFound", + "SharingViolation", + "ShareSnapshotInProgress", + "ShareSnapshotCountExceeded", + "ShareSnapshotOperationNotSupported", + "ShareHasSnapshots", + "ContainerQuotaDowngradeNotAllowed", + "AuthorizationSourceIPMismatch", + "AuthorizationProtocolMismatch", + "AuthorizationPermissionMismatch", + "AuthorizationServiceMismatch", + "AuthorizationResourceTypeMismatch", + "FeatureVersionMismatch" + ], + "x-ms-enum": { + "name": "StorageErrorCode", + "modelAsString": true + } + }, + "FilesAndDirectoriesListSegment": { + "description": "Abstract for entries that can be listed from Directory.", + "type": "object", + "required": [ + "DirectoryItems", + "FileItems" + ], + "properties": { + "DirectoryItems": { + "type": "array", + "items": { + "$ref": "#/definitions/DirectoryItem" + } + }, + "FileItems": { + "type": "array", + "items": { + "$ref": "#/definitions/FileItem" + } + } + }, + "xml": { + "name": "Entries" + } + }, + "DirectoryItem": { + "xml": { + "name": "Directory" + }, + "description": "A listed directory item.", + "type": "object", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string" + }, + "FileId": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/FileProperty" + }, + "Attributes": { + "type": "string" + }, + "PermissionKey": { + "type": "string" + } + } + }, + "FileItem": { + "xml": { + "name": "File" + }, + "description": "A listed file item.", + "type": "object", + "required": [ + "Name", + "Properties" + ], + "properties": { + "Name": { + "type": "string" + }, + "FileId": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/FileProperty" + }, + "Attributes": { + "type": "string" + }, + "PermissionKey": { + "type": "string" + } + } + }, + "FileProperty": { + "description": "File properties.", + "type": "object", + "required": [ + "Content-Length" + ], + "properties": { + "Content-Length": { + "description": "Content length of the file. This value may not be up-to-date since an SMB client may have modified the file locally. The value of Content-Length may not reflect that fact until the handle is closed or the op-lock is broken. To retrieve current property values, call Get File Properties.", + "type": "integer", + "format": "int64" + }, + "CreationTime": { "type": "string", - "x-ms-parameter-location": "method" + "format": "date-time" }, - "FileRangeWriteFromUrl": { - "name": "x-ms-write", - "x-ms-client-name": "fileRangeWriteFromUrl", - "in": "header", - "description": "Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range.", - "required": true, - "type": "string", - "enum": [ - "update" - ], - "default": "update", - "x-ms-enum": { - "name": "FileRangeWriteFromUrlType", - "modelAsString": false - } + "LastAccessTime": { + "type": "string", + "format": "date-time" }, - "FileType": { - "name": "x-ms-type", - "x-ms-client-name": "fileTypeConstant", - "in": "header", - "required": true, - "description": "Dummy constant parameter, file type can only be file.", - "type": "string", - "enum": [ - "file" - ], - "x-ms-parameter-location": "method" + "LastWriteTime": { + "type": "string", + "format": "date-time" }, - "GetRangeContentMD5": { - "name": "x-ms-range-get-content-md5", - "x-ms-client-name": "rangeGetContentMD5", - "in": "header", - "required": false, - "type": "boolean", - "x-ms-parameter-location": "method", - "description": "When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size." + "ChangeTime": { + "type": "string", + "format": "date-time" + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" }, + "Etag": { + "type": "string" + } + } + }, + "HandleItem": { + "xml": { + "name": "Handle" + }, + "description": "A listed Azure Storage handle item.", + "type": "object", + "required": [ + "HandleId", + "Path", + "FileId", + "SessionId", + "ClientIp", + "OpenTime" + ], + "properties": { "HandleId": { - "name": "x-ms-handle-id", - "x-ms-client-name": "handleId", - "in": "header", - "description": "Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" + "type": "string", + "description": "XSMB service handle ID" }, - "LeaseBreakPeriod": { - "name": "x-ms-lease-break-period", - "x-ms-client-name": "breakPeriod", - "in": "header", - "required": false, - "type": "integer", - "x-ms-parameter-location": "method", - "description": "For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately." + "Path": { + "type": "string", + "description": "File or directory name including full path starting from share root" }, - "LeaseDuration": { - "name": "x-ms-lease-duration", - "x-ms-client-name": "duration", - "in": "header", - "required": false, - "type": "integer", - "x-ms-parameter-location": "method", - "description": "Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change." + "FileId": { + "type": "string", + "description": "FileId uniquely identifies the file or directory." }, - "LeaseIdOptional": { - "name": "x-ms-lease-id", - "x-ms-client-name": "leaseId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "lease-access-conditions" - }, - "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + "ParentId": { + "type": "string", + "description": "ParentId uniquely identifies the parent directory of the object." + }, + "SessionId": { + "type": "string", + "description": "SMB session ID in context of which the file handle was opened" + }, + "ClientIp": { + "type": "string", + "description": "Client IP that opened the handle" + }, + "OpenTime": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Time when the session that previously opened the handle has last been reconnected. (UTC)" + }, + "LastReconnectTime": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Time handle was last connected to (UTC)" + } + } + }, + "LeaseDuration": { + "xml": { + "name": "LeaseDuration" + }, + "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "LeaseState": { + "xml": { + "name": "LeaseState" + }, + "description": "Lease state of the share.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "LeaseStatus": { + "xml": { + "name": "LeaseStatus" + }, + "description": "The current lease status of the share.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "ListFilesAndDirectoriesSegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of directories and files.", + "type": "object", + "required": [ + "ServiceEndpoint", + "ShareName", + "DirectoryPath", + "Prefix", + "NextMarker", + "Segment" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } }, - "LeaseIdRequired": { - "name": "x-ms-lease-id", - "x-ms-client-name": "leaseId", - "in": "header", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Specifies the current lease ID on the resource." + "ShareName": { + "type": "string", + "xml": { + "attribute": true + } }, - "ListFilesInclude": { - "name": "include", - "in": "query", - "description": "Include this parameter to specify one or more datasets to include in the response.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string", - "enum": [ - "Timestamps", - "Etag", - "Attributes", - "PermissionKey" - ], - "x-ms-enum": { - "name": "ListFilesIncludeType", - "modelAsString": false - } - }, - "x-ms-parameter-location": "method" + "ShareSnapshot": { + "type": "string", + "xml": { + "attribute": true + } }, - "ListFilesExtendedInfo": { - "name": "x-ms-file-extended-info", - "x-ms-client-name": "includeExtendedInfo", - "x-ms-parameter-location": "method", - "in": "header", - "type": "boolean", - "required": false + "DirectoryPath": { + "type": "string", + "xml": { + "attribute": true + } }, - "ListSharesInclude": { - "name": "include", - "in": "query", - "description": "Include this parameter to specify one or more datasets to include in the response.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string", - "enum": [ - "snapshots", - "metadata", - "deleted" - ], - "x-ms-enum": { - "name": "ListSharesIncludeType", - "modelAsString": false - } - }, - "x-ms-parameter-location": "method" + "Prefix": { + "type": "string" }, "Marker": { - "name": "marker", - "in": "query", - "description": "A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + "type": "string" }, "MaxResults": { - "name": "maxresults", - "in": "query", - "description": "Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.", - "required": false, - "type": "integer", - "minimum": 1, - "x-ms-parameter-location": "method" + "type": "integer" }, - "Metadata": { - "name": "x-ms-meta", - "x-ms-client-name": "metadata", - "in": "header", - "description": "A name-value pair to associate with a file storage object.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-header-collection-prefix": "x-ms-meta-" + "Segment": { + "$ref": "#/definitions/FilesAndDirectoriesListSegment" }, - "OptionalBody": { - "name": "optionalbody", - "in": "body", - "description": "Initial data.", - "required": false, - "schema": { - "type": "object", - "format": "file" - }, - "x-ms-parameter-location": "method" + "NextMarker": { + "type": "string" + }, + "DirectoryId": { + "type": "string" + } + } + }, + "ListHandlesResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of handles.", + "type": "object", + "required": [ + "NextMarker" + ], + "properties": { + "HandleList": { + "type": "array", + "items": { + "$ref": "#/definitions/HandleItem" + }, + "xml": { + "name": "Entries", + "wrapped": true + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "ListSharesResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of shares.", + "type": "object", + "required": [ + "ServiceEndpoint", + "NextMarker" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } }, "Prefix": { - "name": "prefix", - "in": "query", - "description": "Filters the results to return only entries whose name begins with the specified prefix.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + "type": "string" }, - "PrevShareSnapshot": { - "name": "prevsharesnapshot", - "in": "query", - "description": "The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + "Marker": { + "type": "string" }, - "ProposedLeaseIdOptional": { - "name": "x-ms-proposed-lease-id", - "x-ms-client-name": "proposedLeaseId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + "MaxResults": { + "type": "integer" }, - "ProposedLeaseIdRequired": { - "name": "x-ms-proposed-lease-id", - "x-ms-client-name": "proposedLeaseId", - "in": "header", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + "ShareItems": { + "type": "array", + "items": { + "$ref": "#/definitions/ShareItemInternal" + }, + "xml": { + "name": "Shares", + "wrapped": true + } }, - "Range": { - "name": "x-ms-range", - "x-ms-client-name": "range", - "in": "header", - "description": "Return file data only from the specified byte range.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + "NextMarker": { + "type": "string" + } + } + }, + "Metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "Metrics": { + "description": "Storage Analytics metrics for file service.", + "required": [ + "Version", + "Enabled" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether metrics are enabled for the File service.", + "type": "boolean" + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean" }, - "Recursive": { - "name": "x-ms-recursive", - "x-ms-client-name": "recursive", - "in": "header", - "description": "Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.", - "required": false, - "type": "boolean", - "x-ms-parameter-location": "method" + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "SmbMultichannel": { + "description": "Settings for SMB multichannel", + "type": "object", + "properties": { + "Enabled": { + "type": "boolean", + "description": "If SMB multichannel is enabled." + } + }, + "xml": { + "name": "Multichannel" + } + }, + "FileRange": { + "description": "An Azure Storage file range.", + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "description": "Start of the range." + }, + "End": { + "type": "integer", + "format": "int64", + "description": "End of the range." + } + }, + "xml": { + "name": "Range" + } + }, + "ClearRange": { + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "xml": { + "name": "Start" + } + }, + "End": { + "type": "integer", + "format": "int64", + "xml": { + "name": "End" + } + } + }, + "xml": { + "name": "ClearRange" + } + }, + "ShareProtocolSettings": { + "description": "Protocol settings", + "type": "object", + "xml": { + "name": "ProtocolSettings" + }, + "properties": { + "Smb": { + "description": "Settings for SMB protocol.", + "$ref": "#/definitions/ShareSmbSettings" + } + } + }, + "ShareFileRangeList": { + "description": "The list of file ranges", + "type": "object", + "properties": { + "Ranges": { + "type": "array", + "items": { + "$ref": "#/definitions/FileRange" + } + }, + "ClearRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/ClearRange" + } + } + } + }, + "StorageError": { + "type": "object", + "properties": { + "Message": { + "type": "string" + } + } + }, + "RetentionPolicy": { + "description": "The retention policy.", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it.", + "type": "boolean" + }, + "Days": { + "description": "Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires.", + "type": "integer", + "minimum": 1, + "maximum": 365 + } + } + }, + "ShareItemInternal": { + "xml": { + "name": "Share" + }, + "description": "A listed Azure Storage share item.", + "type": "object", + "required": [ + "Name", + "Properties" + ], + "properties": { + "Name": { + "type": "string" }, - "Url": { - "name": "url", - "in": "path", - "description": "The URL of the service account, share, directory or file that is the target of the desired operation.", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true + "Snapshot": { + "type": "string" }, - "ShareAcl": { - "name": "shareAcl", - "in": "body", - "description": "The ACL for the share.", - "schema": { - "$ref": "#/definitions/SignedIdentifiers" - }, - "x-ms-parameter-location": "method" + "Deleted": { + "type": "boolean" }, - "ShareQuota": { - "name": "x-ms-share-quota", - "x-ms-client-name": "quota", - "in": "header", - "description": "Specifies the maximum size of the share, in gigabytes.", - "required": false, - "type": "integer", - "minimum": 1, - "x-ms-parameter-location": "method" + "Version": { + "type": "string" }, - "ShareSnapshot": { - "name": "sharesnapshot", - "in": "query", - "description": "The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + "Properties": { + "$ref": "#/definitions/SharePropertiesInternal" }, - "SourceContentCrc64": { - "name": "x-ms-source-content-crc64", - "x-ms-client-name": "sourceContentCrc64", - "in": "header", - "required": false, + "Metadata": { + "$ref": "#/definitions/Metadata" + } + } + }, + "SharePropertiesInternal": { + "description": "Properties of a share.", + "type": "object", + "required": [ + "Last-Modified", + "Etag", + "Quota" + ], + "properties": { + "Last-Modified": { "type": "string", - "format": "byte", - "x-ms-parameter-location": "method", - "description": "Specify the crc64 calculated for the range of bytes that must be read from the copy source." + "format": "date-time-rfc1123" }, - "SourceIfMatchCrc64": { - "name": "x-ms-source-if-match-crc64", - "x-ms-client-name": "sourceIfMatchCrc64", - "in": "header", - "required": false, + "Etag": { + "type": "string" + }, + "Quota": { + "type": "integer" + }, + "ProvisionedIops": { + "type": "integer" + }, + "ProvisionedIngressMBps": { + "type": "integer" + }, + "ProvisionedEgressMBps": { + "type": "integer" + }, + "NextAllowedQuotaDowngradeTime": { "type": "string", - "format": "byte", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "source-modified-access-conditions" - }, - "description": "Specify the crc64 value to operate only on range with a matching crc64 checksum." + "format": "date-time-rfc1123" }, - "SourceIfNoneMatchCrc64": { - "name": "x-ms-source-if-none-match-crc64", - "x-ms-client-name": "sourceIfNoneMatchCrc64", - "in": "header", - "required": false, + "DeletedTime": { "type": "string", - "format": "byte", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "source-modified-access-conditions" - }, - "description": "Specify the crc64 value to operate only on range without a matching crc64 checksum." + "format": "date-time-rfc1123" }, - "SourceRange": { - "name": "x-ms-source-range", - "x-ms-client-name": "sourceRange", - "in": "header", - "required": false, + "RemainingRetentionDays": { + "type": "integer" + }, + "AccessTier": { + "type": "string" + }, + "AccessTierChangeTime": { "type": "string", - "x-ms-parameter-location": "method", - "description": "Bytes of source data in the specified range." + "format": "date-time-rfc1123" }, - "StorageServiceProperties": { - "name": "StorageServiceProperties", - "in": "body", - "description": "The StorageService properties.", - "required": true, - "schema": { - "$ref": "#/definitions/StorageServiceProperties" - }, - "x-ms-parameter-location": "method" + "AccessTierTransitionState": { + "type": "string" }, - "TargetRange": { - "name": "x-ms-range", - "x-ms-client-name": "Range", - "in": "header", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Writes data to the specified byte range in the file." - }, - "Timeout": { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.", - "required": false, - "type": "integer", - "minimum": 0, - "x-ms-parameter-location": "method" + "LeaseStatus": { + "$ref": "#/definitions/LeaseStatus" }, - "SharePermission": { - "name": "sharePermission", - "in": "body", - "description": "A permission (a security descriptor) at the share level.", - "required": true, - "schema": { - "$ref": "#/definitions/SharePermission" - }, - "x-ms-parameter-location": "method" + "LeaseState": { + "$ref": "#/definitions/LeaseState" }, - "ShareEnabledProtocols": { - "name": "x-ms-enabled-protocols", - "description": "Protocols to enable on the share.", - "x-ms-client-name": "enabledProtocols", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + "LeaseDuration": { + "$ref": "#/definitions/LeaseDuration" }, - "ShareRootSquash": { - "name": "x-ms-root-squash", - "description": "Root squash to set on the share. Only valid for NFS shares.", - "x-ms-client-name": "rootSquash", - "in": "header", - "required": false, - "type": "string", - "enum": [ - "NoRootSquash", - "RootSquash", - "AllSquash" - ], - "x-ms-enum": { - "name": "ShareRootSquash", - "modelAsString": false - }, - "x-ms-parameter-location": "method" + "EnabledProtocols": { + "$ref": "#/definitions/ShareEnabledProtocols" + }, + "RootSquash": { + "$ref": "#/definitions/ShareRootSquash" + } + } + }, + "ShareStats": { + "description": "Stats for the share.", + "type": "object", + "required": [ + "ShareUsageBytes" + ], + "properties": { + "ShareUsageBytes": { + "description": "The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files.", + "type": "integer" + } + } + }, + "SignedIdentifier": { + "description": "Signed identifier.", + "type": "object", + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "string", + "description": "A unique id." + }, + "AccessPolicy": { + "description": "The access policy.", + "$ref": "#/definitions/AccessPolicy" + } + } + }, + "SignedIdentifiers": { + "description": "A collection of signed identifiers.", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier", + "xml": { + "name": "SignedIdentifier" + } + }, + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" + } + }, + "ShareSmbSettings": { + "description": "Settings for SMB protocol.", + "type": "object", + "xml": { + "name": "SMB" + }, + "properties": { + "Multichannel": { + "description": "Settings for SMB Multichannel.", + "$ref": "#/definitions/SmbMultichannel" + } + } + }, + "StorageServiceProperties": { + "description": "Storage service properties.", + "type": "object", + "properties": { + "HourMetrics": { + "description": "A summary of request statistics grouped by API in hourly aggregates for files.", + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "description": "A summary of request statistics grouped by API in minute aggregates for files.", + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule" + }, + "xml": { + "wrapped": true + } + }, + "Protocol": { + "description": "Protocol settings", + "$ref": "#/definitions/ShareProtocolSettings" + } + } + }, + "SharePermission": { + "description": "A permission (a security descriptor) at the share level.", + "type": "object", + "required": [ + "permission" + ], + "properties": { + "permission": { + "type": "string", + "description": "The permission in the Security Descriptor Definition Language (SDDL)." + } + } + }, + "ShareEnabledProtocols": { + "type": "string" + }, + "ShareRootSquash": { + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + } + } + }, + "parameters": { + "AccessTierOptional": { + "name": "x-ms-access-tier", + "x-ms-client-name": "accessTier", + "in": "header", + "description": "Specifies the access tier of the share.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "enum": [ + "TransactionOptimized", + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "ShareAccessTier", + "modelAsString": true + } + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-client-name": "version", + "x-ms-parameter-location": "client", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "enum": [ + "2020-10-02" + ] + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "ContentLength": { + "name": "Content-Length", + "x-ms-client-name": "contentLength", + "in": "header", + "description": "Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero.", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "ContentMD5": { + "name": "Content-MD5", + "x-ms-client-name": "contentMD5", + "in": "header", + "description": "An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request).", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method" + }, + "CopyActionAbort": { + "name": "x-ms-copy-action", + "x-ms-client-name": "copyActionAbortConstant", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "abort" + ], + "x-ms-parameter-location": "method", + "description": "Abort." + }, + "CopyId": { + "name": "copyid", + "x-ms-client-name": "copyId", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy File operation." + }, + "CopySource": { + "name": "x-ms-copy-source", + "x-ms-client-name": "copySource", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source." + }, + "CopySourceAuthorization": { + "name": "x-ms-copy-source-authorization", + "x-ms-client-name": "copySourceAuthorization", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source." + }, + "FileCopyPermissionCopyMode": { + "name": "x-ms-file-permission-copy-mode", + "x-ms-client-name": "filePermissionCopyMode", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "PermissionCopyModeType", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key." + }, + "FileCopyIgnoreReadOnly": { + "name": "x-ms-file-copy-ignore-read-only", + "x-ms-client-name": "ignoreReadOnly", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to overwrite the target file if it already exists and has read-only attribute set." + }, + "FileCopyFileAttributes": { + "name": "x-ms-file-attributes", + "x-ms-client-name": "fileAttributes", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file." + }, + "FileCopyFileCreationTime": { + "name": "x-ms-file-creation-time", + "x-ms-client-name": "fileCreationTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file." + }, + "FileCopyFileLastWriteTime": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "fileLastWriteTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file." + }, + "FileCopySetArchiveAttribute": { + "name": "x-ms-file-copy-set-archive", + "x-ms-client-name": "setArchiveAttribute", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state." + }, + "DeletedShareName": { + "name": "x-ms-deleted-share-name", + "x-ms-client-name": "DeletedShareName", + "description": "Specifies the name of the previously-deleted share.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DirectoryPath": { + "name": "directory", + "in": "path", + "description": "The path of the target directory.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": false + }, + "FilePath": { + "name": "fileName", + "in": "path", + "description": "The path of the target file.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": false + }, + "ShareName": { + "name": "shareName", + "in": "path", + "description": "The name of the target share.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeletedShareVersion": { + "name": "x-ms-deleted-share-version", + "x-ms-client-name": "DeletedShareVersion", + "description": "Specifies the version of the previously-deleted share.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeleteSnapshots": { + "name": "x-ms-delete-snapshots", + "x-ms-client-name": "deleteSnapshots", + "description": "Specifies the option include to delete the base share and all of its snapshots.", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "include", + "include-leased" + ], + "x-ms-enum": { + "name": "DeleteSnapshotsOptionType", + "modelAsString": false + }, + "x-ms-parameter-location": "method" + }, + "FileAttributes": { + "name": "x-ms-file-attributes", + "x-ms-client-name": "FileAttributes", + "in": "header", + "description": "If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileCacheControl": { + "name": "x-ms-cache-control", + "x-ms-client-name": "fileCacheControl", + "description": "Sets the file's cache control. The File service stores this value but does not use or modify it.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentDisposition": { + "name": "x-ms-content-disposition", + "x-ms-client-name": "fileContentDisposition", + "description": "Sets the file's Content-Disposition header.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentEncoding": { + "name": "x-ms-content-encoding", + "x-ms-client-name": "fileContentEncoding", + "in": "header", + "description": "Specifies which content encodings have been applied to the file.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentLanguage": { + "name": "x-ms-content-language", + "x-ms-client-name": "fileContentLanguage", + "in": "header", + "description": "Specifies the natural languages used by this resource.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentMD5": { + "name": "x-ms-content-md5", + "x-ms-client-name": "fileContentMD5", + "in": "header", + "description": "Sets the file's MD5 hash.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentType": { + "name": "x-ms-content-type", + "x-ms-client-name": "fileContentType", + "in": "header", + "description": "Sets the MIME content type of the file. The default type is 'application/octet-stream'.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileCreationTime": { + "name": "x-ms-file-creation-time", + "x-ms-client-name": "FileCreationTime", + "in": "header", + "description": "Creation time for the file/directory. Default value: Now.", + "required": true, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileLastWriteTime": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "FileLastWriteTime", + "in": "header", + "description": "Last write time for the file/directory. Default value: Now.", + "required": true, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FilePermission": { + "name": "x-ms-file-permission", + "x-ms-client-name": "FilePermission", + "in": "header", + "description": "If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FilePermissionKey": { + "name": "x-ms-file-permission-key", + "x-ms-client-name": "FilePermissionKey", + "in": "header", + "description": "Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FilePermissionKeyRequired": { + "name": "x-ms-file-permission-key", + "x-ms-client-name": "FilePermissionKey", + "in": "header", + "description": "Key of the permission to be set for the directory/file.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileRangeWriteFromUrl": { + "name": "x-ms-write", + "x-ms-parameter-location": "client", + "x-ms-client-name": "fileRangeWriteFromUrl", + "in": "header", + "description": "Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range.", + "required": true, + "type": "string", + "enum": [ + "update" + ], + "default": "update", + "x-ms-enum": { + "name": "FileRangeWriteFromUrlType", + "modelAsString": false + } + }, + "FileType": { + "name": "x-ms-type", + "x-ms-client-name": "fileTypeConstant", + "in": "header", + "required": true, + "description": "Dummy constant parameter, file type can only be file.", + "type": "string", + "enum": [ + "file" + ], + "x-ms-parameter-location": "method" + }, + "GetRangeContentMD5": { + "name": "x-ms-range-get-content-md5", + "x-ms-client-name": "rangeGetContentMD5", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size." + }, + "HandleId": { + "name": "x-ms-handle-id", + "x-ms-client-name": "handleId", + "in": "header", + "description": "Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LeaseBreakPeriod": { + "name": "x-ms-lease-break-period", + "x-ms-client-name": "breakPeriod", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately." + }, + "LeaseDuration": { + "name": "x-ms-lease-duration", + "x-ms-client-name": "duration", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change." + }, + "LeaseIdOptional": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "lease-access-conditions" + }, + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + }, + "LeaseIdRequired": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the current lease ID on the resource." + }, + "ListFilesInclude": { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "Timestamps", + "Etag", + "Attributes", + "PermissionKey" + ], + "x-ms-enum": { + "name": "ListFilesIncludeType", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method" + }, + "ListFilesExtendedInfo": { + "name": "x-ms-file-extended-info", + "x-ms-client-name": "includeExtendedInfo", + "x-ms-parameter-location": "method", + "in": "header", + "type": "boolean", + "required": false, + "description": "Include extended information." + }, + "ListSharesInclude": { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "snapshots", + "metadata", + "deleted" + ], + "x-ms-enum": { + "name": "ListSharesIncludeType", + "modelAsString": false } + }, + "x-ms-parameter-location": "method" + }, + "Marker": { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MaxResults": { + "name": "maxresults", + "in": "query", + "description": "Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "Metadata": { + "name": "x-ms-meta", + "x-ms-client-name": "metadata", + "in": "header", + "description": "A name-value pair to associate with a file storage object.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "OptionalBody": { + "name": "optionalbody", + "in": "body", + "description": "Initial data.", + "required": false, + "schema": { + "type": "object", + "format": "file" + }, + "x-ms-parameter-location": "method" + }, + "Prefix": { + "name": "prefix", + "in": "query", + "description": "Filters the results to return only entries whose name begins with the specified prefix.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrevShareSnapshot": { + "name": "prevsharesnapshot", + "in": "query", + "description": "The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ProposedLeaseIdOptional": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "ProposedLeaseIdRequired": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "Range": { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Return file data only from the specified byte range.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Recursive": { + "name": "x-ms-recursive", + "x-ms-client-name": "recursive", + "in": "header", + "description": "Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "Url": { + "name": "url", + "x-ms-parameter-location": "client", + "in": "path", + "description": "The URL of the service account, share, directory or file that is the target of the desired operation.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + "ShareAcl": { + "name": "shareAcl", + "in": "body", + "description": "The ACL for the share.", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method" + }, + "ShareQuota": { + "name": "x-ms-share-quota", + "x-ms-client-name": "quota", + "in": "header", + "description": "Specifies the maximum size of the share, in gigabytes.", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "ShareSnapshot": { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SourceContentCrc64": { + "name": "x-ms-source-content-crc64", + "x-ms-client-name": "sourceContentCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the crc64 calculated for the range of bytes that must be read from the copy source." + }, + "SourceIfMatchCrc64": { + "name": "x-ms-source-if-match-crc64", + "x-ms-client-name": "sourceIfMatchCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify the crc64 value to operate only on range with a matching crc64 checksum." + }, + "SourceIfNoneMatchCrc64": { + "name": "x-ms-source-if-none-match-crc64", + "x-ms-client-name": "sourceIfNoneMatchCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify the crc64 value to operate only on range without a matching crc64 checksum." + }, + "SourceRange": { + "name": "x-ms-source-range", + "x-ms-client-name": "sourceRange", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Bytes of source data in the specified range." + }, + "StorageServiceProperties": { + "name": "StorageServiceProperties", + "in": "body", + "description": "The StorageService properties.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + }, + "x-ms-parameter-location": "method" + }, + "TargetRange": { + "name": "x-ms-range", + "x-ms-client-name": "Range", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Writes data to the specified byte range in the file." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method" + }, + "SharePermission": { + "name": "sharePermission", + "in": "body", + "description": "A permission (a security descriptor) at the share level.", + "required": true, + "schema": { + "$ref": "#/definitions/SharePermission" + }, + "x-ms-parameter-location": "method" + }, + "ShareEnabledProtocols": { + "name": "x-ms-enabled-protocols", + "description": "Protocols to enable on the share.", + "x-ms-client-name": "enabledProtocols", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ShareRootSquash": { + "name": "x-ms-root-squash", + "description": "Root squash to set on the share. Only valid for NFS shares.", + "x-ms-client-name": "rootSquash", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + }, + "x-ms-parameter-location": "method" } + } } diff --git a/specification/storage/data-plane/Microsoft.FileStorage/preview/2020-10-02/readme.md b/specification/storage/data-plane/Microsoft.FileStorage/preview/2020-10-02/readme.md deleted file mode 100644 index 15f94a520b99..000000000000 --- a/specification/storage/data-plane/Microsoft.FileStorage/preview/2020-10-02/readme.md +++ /dev/null @@ -1,28 +0,0 @@ -# Storage Dataplane - -> see https://aka.ms/autorest - -``` yaml -input-file: ./file.json -azure-validator: true -openapi-type: data-plane - -directive: - # These directives are suppressed but do not block generating documentation - - suppress: R3016 # Properties must be camelCase - - suppress: R2058 # Paths in x-ms-paths must overload a normal path in the paths section, i.e. a path in the x-ms-paths must either be same as - # a path in the paths section or a path in the paths sections followed by additional parameters. - - # These directives are temporarily suppressed. They should be removed from this file before Swaggers can be used to generate documentation. The Swaggers can still be used to generate code with these directives suppressed. Tracking with work item #2181761. - - suppress: R2022 # Add x-ms-examples - - suppress: R2003 # etag / url is not a known format - - suppress: R4000 # Missing description - - suppress: R4001 # url defined in global param without extension - - suppress: D5001 # x-ms-examples describing minimum/maximum property set for response/request payloads for operations - - # Errors being temporarily suppressed while we work on swagger improvements in our fork - - suppress: UNREFERENCED_JSON_FILE # This is because of the top level DataLake readme - - where: $["x-ms-paths"][*][*] - suppress: - - MISSING_PATH_PARAMETER_DEFINITION # Storage generators ignore path parameters so they're not in the swagger -``` diff --git a/specification/storage/data-plane/Microsoft.FileStorage/readme.md b/specification/storage/data-plane/Microsoft.FileStorage/readme.md new file mode 100644 index 000000000000..1b6d9b583127 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.FileStorage/readme.md @@ -0,0 +1,53 @@ +# FileStorage + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for FileStorage. + + +--- +## Getting Started +To build the SDK for FileStorage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the FileStorage API. + +``` yaml +openapi-type: data-plane +tag: package-2020-10 +use-internal-constructors: true +add-credentials: true +``` + +### Tag: package-2020-10 + +These settings apply only when `--tag=package-2020-10` is specified on the command line. + +``` yaml $(tag) == 'package-2020-10' +input-file: +- preview/2020-10-02/file.json +``` + +### Suppression +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: preview/2020-10-02/file.json + reason: These parameters are predfined by storage specifications + - suppress: XmsPathsMustOverloadPaths + from: preview/2020-10-02/file.json + - suppress: XmsExamplesRequired + from: preview/2020-10-02/file.json +``` +--- \ No newline at end of file diff --git a/specification/storage/data-plane/Microsoft.QueueStorage/preview/2018-03-28/queue.json b/specification/storage/data-plane/Microsoft.QueueStorage/preview/2018-03-28/queue.json index 4eb103709ab3..17bc3a28c739 100644 --- a/specification/storage/data-plane/Microsoft.QueueStorage/preview/2018-03-28/queue.json +++ b/specification/storage/data-plane/Microsoft.QueueStorage/preview/2018-03-28/queue.json @@ -140,6 +140,7 @@ "parameters": [ { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -149,6 +150,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -217,6 +219,7 @@ "parameters": [ { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -226,6 +229,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -309,6 +313,7 @@ "parameters": [ { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -446,7 +451,11 @@ } } }, - "parameters": [] + "parameters": [ + { + "$ref": "#/parameters/QueueName" + } + ] }, "/{queueName}?comp=metadata": { "get": { @@ -567,8 +576,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/QueueName" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -690,8 +703,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/QueueName" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -815,9 +832,6 @@ } } }, - "parameters": [] - }, - "/{queueName}/messages?visibilitytimeout={visibilityTimeout}&messagettl={messageTimeToLive}": { "post": { "tags": [ "message" @@ -882,7 +896,11 @@ } } }, - "parameters": [] + "parameters": [ + { + "$ref": "#/parameters/QueueName" + } + ] }, "/{queueName}/messages?peekonly=true": { "get": { @@ -944,8 +962,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/QueueName" + }, { "name": "peekonly", + "description": "Peek message(s).", "in": "query", "required": true, "type": "string", @@ -955,7 +977,7 @@ } ] }, - "/{queueName}/messages/{messageid}?popreceipt={popReceipt}&visibilitytimeout={visibilityTimeout}": { + "/{queueName}/messages/{messageid}": { "put": { "tags": [ "messageId" @@ -1028,9 +1050,6 @@ } } }, - "parameters": [] - }, - "/{queueName}/messages/{messageid}?popreceipt={popReceipt}": { "delete": { "tags": [ "messageId" @@ -1086,7 +1105,14 @@ } } }, - "parameters": [] + "parameters": [ + { + "$ref": "#/parameters/QueueName" + }, + { + "$ref": "#/parameters/MessageId" + } + ] } }, "definitions": { @@ -1328,7 +1354,7 @@ } }, "Metrics": { - "description": "", + "description": "a summary of request statistics grouped by API in hour or minute aggregates for queues", "required": [ "Enabled" ], @@ -1650,6 +1676,7 @@ "parameters": { "Url": { "name": "url", + "x-ms-parameter-location": "client", "description": "The URL of the service account, queue or message that is the target of the desired operation.", "required": true, "type": "string", @@ -1658,6 +1685,7 @@ }, "ApiVersionParameter": { "name": "x-ms-version", + "x-ms-parameter-location": "client", "x-ms-client-name": "version", "in": "header", "required": true, @@ -1706,23 +1734,23 @@ "description": "The length of the request." }, "ListQueuesInclude": { - "name": "include", - "in": "query", - "required": false, + "name": "include", + "in": "query", + "required": false, "type": "array", "collectionFormat": "csv", "items": { - "type": "string", - "enum": [ - "metadata" - ], - "x-ms-enum": { - "name": "ListQueuesIncludeType", - "modelAsString": false + "type": "string", + "enum": [ + "metadata" + ], + "x-ms-enum": { + "name": "ListQueuesIncludeType", + "modelAsString": false } }, "x-ms-parameter-location": "method", - "description": "Include this parameter to specify that the queues's metadata be returned as part of the response body." + "description": "Include this parameter to specify that the queues' metadata be returned as part of the response body." }, "Marker": { "name": "marker", diff --git a/specification/storage/data-plane/Microsoft.QueueStorage/preview/2018-03-28/readme.md b/specification/storage/data-plane/Microsoft.QueueStorage/preview/2018-03-28/readme.md deleted file mode 100644 index 48487c4e9ab4..000000000000 --- a/specification/storage/data-plane/Microsoft.QueueStorage/preview/2018-03-28/readme.md +++ /dev/null @@ -1,27 +0,0 @@ -# Storage Dataplane - -> see https://aka.ms/autorest - -``` yaml -input-file: ./queue.json -azure-validator: true -openapi-type: data-plane - -directive: - # These directives are suppressed but do not block generating documentation - - suppress: R3016 # Properties must be camelCase - - suppress: R2058 # Paths in x-ms-paths must overload a normal path in the paths section, i.e. a path in the x-ms-paths must either be same as - # a path in the paths section or a path in the paths sections followed by additional parameters. - - # These directives are temporarily suppressed. They should be removed from this file before Swaggers can be used to generate documentation. The Swaggers can still be used to generate code with these directives suppressed. Tracking with work item #2181761. - - suppress: R2022 # Add x-ms-examples - - suppress: R4000 # Missing description - - suppress: R4001 # url defined in global param without extension - - suppress: D5001 # x-ms-examples describing minimum/maximum property set for response/request payloads for operations - - # Errors being temporarily suppressed while we work on swagger improvements in our fork - - suppress: UNREFERENCED_JSON_FILE # This is because of the top level DataLake readme - - where: $["x-ms-paths"][*][*] - suppress: - - MISSING_PATH_PARAMETER_DEFINITION # Storage generators ignore path parameters so they're not in the swagger -``` diff --git a/specification/storage/data-plane/Microsoft.QueueStorage/readme.md b/specification/storage/data-plane/Microsoft.QueueStorage/readme.md new file mode 100644 index 000000000000..67d048a34103 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.QueueStorage/readme.md @@ -0,0 +1,53 @@ +# QueueStorage + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for QueueStorage. + + +--- +## Getting Started +To build the SDK for QueueStorage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the QueueStorage API. + +``` yaml +openapi-type: data-plane +tag: package-2018-03 +use-internal-constructors: true +add-credentials: true +``` + +### Tag: package-2018-03 + +These settings apply only when `--tag=package-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03' +input-file: +- preview/2018-03-28/queue.json +``` + +### Suppression +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: preview/2018-03-28/queue.json + reason: These parameters are predfined by storage specifications + - suppress: XmsPathsMustOverloadPaths + from: preview/2018-03-28/queue.json + - suppress: XmsExamplesRequired + from: preview/2018-03-28/queue.json +``` +--- \ No newline at end of file diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.md b/specification/storage/data-plane/Microsoft.StorageDataLake/readme.md new file mode 100644 index 000000000000..a89df0638a46 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/readme.md @@ -0,0 +1,56 @@ +# StorageDataLake + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for StorageDataLake. + + +--- +## Getting Started +To build the SDK for StorageDataLake, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the StorageDataLake API. + +``` yaml +openapi-type: data-plane +tag: package-2020-06 +use-internal-constructors: true +add-credentials: true +``` + +### Tag: package-2020-06 + +These settings apply only when `--tag=package-2020-06` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06' +input-file: +- stable/2020-06-12/DataLakeStorage.json +``` + +### Suppression +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: stable/2020-06-12/DataLakeStorage.json + reason: These parameters are predfined by storage specifications + - suppress: XmsPathsMustOverloadPaths + from: stable/2020-06-12/DataLakeStorage.json + - suppress: XmsExamplesRequired + from: stable/2020-06-12/DataLakeStorage.json + - suppress: OperationIdNounConflictingModelNames + from: stable/2020-06-12/DataLakeStorage.json + reason: This is only a warning. Changing these definitions would be a massive breaking change to our clients +``` +--- \ No newline at end of file diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2020-06-12/DataLakeStorage.json b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2020-06-12/DataLakeStorage.json index dfbbb379b3c5..0e2d27275fd8 100644 --- a/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2020-06-12/DataLakeStorage.json +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2020-06-12/DataLakeStorage.json @@ -151,7 +151,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the FileSystem.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -220,7 +219,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -273,7 +271,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -370,6 +367,9 @@ ] }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, { "$ref": "#/parameters/FileSystemResource" }, @@ -424,7 +424,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -468,6 +467,9 @@ } }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, { "$ref": "#/parameters/FileSystemResource" }, @@ -572,8 +574,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, { "name": "restype", + "description": "restype", "in": "query", "required": true, "type": "string", @@ -583,6 +589,7 @@ }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -650,10 +657,10 @@ "$ref": "#/parameters/ContentDisposition" }, { - "$ref": "#/parameters/ContentType" + "$ref": "#/parameters/ContentType" }, { - "$ref": "#/parameters/RenameSource" + "$ref": "#/parameters/RenameSource" }, { "$ref": "#/parameters/LeaseIdOptional" @@ -706,7 +713,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -792,7 +798,7 @@ { "name": "continuation", "in": "query", - "description": "Optional. The number of paths processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be percent-encoded and specified in a subsequent invocation of setAcessControlRecursive operation.", + "description": "Optional. The number of paths processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be percent-encoded and specified in a subsequent invocation of setAccessControlRecursive operation.", "required": false, "type": "string" }, @@ -877,7 +883,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -1041,7 +1046,7 @@ "$ref": "#/parameters/IfNoneMatch" }, { - "$ref": "#/parameters/IfModifiedSince" + "$ref": "#/parameters/IfModifiedSince" }, { "$ref": "#/parameters/IfUnmodifiedSince" @@ -1058,7 +1063,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the file.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -1095,7 +1099,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -1127,7 +1130,6 @@ "headers": { "ETag": { "description": "An HTTP entity tag associated with the file or directory.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -1253,7 +1255,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -1354,7 +1355,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -1508,7 +1508,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -1665,6 +1664,12 @@ } }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, { "$ref": "#/parameters/ClientRequestId" }, @@ -1732,7 +1737,6 @@ }, "ETag": { "type": "string", - "format": "etag", "description": "An HTTP entity tag associated with the file or directory." }, "Last-Modified": { @@ -1783,8 +1787,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, { "name": "action", + "description": "action", "in": "query", "required": true, "type": "string", @@ -1800,7 +1811,7 @@ "directory" ], "operationId": "Path_SetAccessControlRecursive", - "description": "Set the access control list for a path and subpaths.", + "description": "Set the access control list for a path and sub-paths.", "parameters": [ { "$ref": "#/parameters/Timeout" @@ -1893,8 +1904,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, { "name": "action", + "description": "action", "in": "query", "required": true, "type": "string", @@ -1978,7 +1996,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", - "format": "etag", "type": "string" }, "Last-Modified": { @@ -2035,8 +2052,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, { "name": "action", + "description": "action", "in": "query", "required": true, "type": "string", @@ -2108,7 +2132,6 @@ }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", - "format": "etag", "type": "string" }, "Content-MD5": { @@ -2154,8 +2177,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, { "name": "action", + "description": "action", "in": "query", "required": true, "type": "string", @@ -2195,7 +2225,6 @@ "headers": { "ETag": { "type": "string", - "format": "etag", "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." }, "Last-Modified": { @@ -2240,8 +2269,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -2318,8 +2354,15 @@ } }, "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, { "name": "comp", + "description": "comp", "in": "query", "required": true, "type": "string", @@ -2335,26 +2378,29 @@ "name": "url", "description": "The URL of the service account, container, or blob that is the target of the desired operation.", "required": true, + "x-ms-parameter-location": "client", "type": "string", "in": "path", "x-ms-skip-url-encoding": true }, "FileSystemResource": { - "name": "resource", - "in": "query", - "description": "The value must be \"filesystem\" for all filesystem operations.", - "required": true, - "type": "string", - "enum": [ - "filesystem" - ], - "x-ms-enum": { - "name": "FileSystemResourceType", - "modelAsString": false - } - }, + "name": "resource", + "in": "query", + "x-ms-parameter-location": "client", + "description": "The value must be \"filesystem\" for all filesystem operations.", + "required": true, + "type": "string", + "enum": [ + "filesystem" + ], + "x-ms-enum": { + "name": "FileSystemResourceType", + "modelAsString": false + } + }, "ApiVersionParameter": { "name": "x-ms-version", + "x-ms-parameter-location": "client", "x-ms-client-name": "version", "in": "header", "required": true, @@ -2407,7 +2453,6 @@ "in": "header", "required": false, "type": "string", - "format": "etag", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "modified-access-conditions" @@ -2433,7 +2478,6 @@ "in": "header", "required": false, "type": "string", - "format": "etag", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "modified-access-conditions" @@ -2455,7 +2499,6 @@ }, "RecursiveOptional": { "name": "recursive", - "x-ms-client-name": "recursive", "x-ms-parameter-location": "method", "in": "query", "description": "Required", @@ -2464,7 +2507,6 @@ }, "RecursiveRequired": { "name": "recursive", - "x-ms-client-name": "recursive", "x-ms-parameter-location": "method", "in": "query", "description": "Required", @@ -2473,7 +2515,6 @@ }, "Continuation": { "name": "continuation", - "x-ms-client-name": "continuation", "x-ms-parameter-location": "method", "in": "query", "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", @@ -2491,7 +2532,7 @@ "set", "modify", "remove" - ], + ], "x-ms-enum": { "name": "PathSetAccessControlRecursiveMode", "modelAsString": false @@ -2499,7 +2540,6 @@ }, "ForceFlag": { "name": "forceFlag", - "x-ms-client-name": "forceFlag", "x-ms-parameter-location": "method", "in": "query", "description": "Optional. Valid for \"SetAccessControlRecursive\" operation. If set to false, the operation will terminate quickly on encountering user errors (4XX). If true, the operation will ignore user errors and proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag is true in case of user errors. If not set the default value is false for this.", @@ -2578,7 +2618,6 @@ "in": "header", "required": false, "type": "string", - "format": "etag", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "source-modified-access-conditions" @@ -2604,7 +2643,6 @@ "in": "header", "required": false, "type": "string", - "format": "etag", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "source-modified-access-conditions" @@ -2635,6 +2673,7 @@ }, "FileSystem": { "name": "filesystem", + "x-ms-parameter-location": "client", "x-ms-client-name": "fileSystem", "in": "path", "description": "The filesystem identifier.", @@ -2646,6 +2685,7 @@ }, "Path": { "name": "path", + "x-ms-parameter-location": "client", "in": "path", "description": "The file or directory path.", "required": true, @@ -2854,7 +2894,7 @@ "type": "integer", "format": "int64", "x-ms-parameter-location": "method" - }, + }, "PathExpiryOptions": { "name": "x-ms-expiry-option", "x-ms-client-name": "ExpiryOptions", @@ -3177,8 +3217,7 @@ "format": "date-time-rfc1123" }, "Etag": { - "type": "string", - "format": "etag" + "type": "string" }, "Content-Length": { "type": "integer", diff --git a/specification/storage/data-plane/readme.go.md b/specification/storage/data-plane/readme.go.md deleted file mode 100644 index 7c5751255cb4..000000000000 --- a/specification/storage/data-plane/readme.go.md +++ /dev/null @@ -1,36 +0,0 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - namespace: storagedatalake - clear-output-folder: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2018-11 - - tag: package-2018-06-preview -``` - -### Tag: package-2018-11 and go - -These settings apply only when `--tag=package-2018-11 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2018-11' && $(go) -output-folder: $(go-sdk-folder)/services/storage/datalake/2018-11-09/$(namespace) -``` - -### Tag: package-2018-06-preview and go - -These settings apply only when `--tag=package-2018-06-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2018-06-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/storage/datalake/2018-06-17/$(namespace) -``` diff --git a/specification/storage/data-plane/readme.md b/specification/storage/data-plane/readme.md index 4f252142643f..2045fdc8bbb0 100644 --- a/specification/storage/data-plane/readme.md +++ b/specification/storage/data-plane/readme.md @@ -1,14 +1,13 @@ -# DataLakeStorage +# Storage > see https://aka.ms/autorest -This is the AutoRest configuration file for DataLakeStorage. - +This is the AutoRest configuration file for Azure Storage. --- ## Getting Started -To build the SDK for DataLakeStorage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: +To build the SDK for Storage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -22,151 +21,59 @@ To see additional help and options, run: ### Basic Information -These are the global settings for the DataLakeStorage API. +These are the global settings for the Storage APIs. ``` yaml +title: StorageClient +description: Storage Client openapi-type: data-plane -tag: package-2018-11 +tag: package-2020-03 use-internal-constructors: true add-credentials: true ``` -### Tag: package-2019-12 +### Tag: blob-package-2020-10 -These settings apply only when `--tag=package-2019-12` is specified on the command line. +These settings apply only when `--tag=blob-package-2020-10` is specified on the command line. -``` yaml $(tag) == 'package-2019-12' +``` yaml $(tag) == 'blob-package-2020-10' input-file: -- Microsoft.BlobStorage/preview/2019-12-12/blob.json +- Microsoft.BlobStorage/preview/2020-10-02/blob.json ``` -### Tag: package-2018-11 +### Tag: datalake-package-2020-06 -These settings apply only when `--tag=package-2018-11` is specified on the command line. +These settings apply only when `--tag=datalake-package-2020-06` is specified on the command line. -``` yaml $(tag) == 'package-2018-11' +``` yaml $(tag) == 'datalake-package-2020-06' input-file: -- Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json +- Microsoft.StorageDataLake/stable/2020-06-12/DataLakeStorage.json ``` -### Tag: package-2018-06-preview +### Tag: file-package-2020-10 -These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. +These settings apply only when `--tag=file-package-2020-10` is specified on the command line. -``` yaml $(tag) == 'package-2018-06-preview' +``` yaml $(tag) == 'file-package-2020-10' input-file: -- Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -Swagger to SDK has been intentionally disabled for this spec. - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Storage.DataLake - output-folder: $(csharp-sdks-folder)/Storage/DataLake/Generated - clear-output-folder: true +- Microsoft.FileStorage/preview/2020-10-02/file.json ``` +### Tag: queue-package-2018-03 -## Python +These settings apply only when `--tag=queue-package-2018-03` is specified on the command line. -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.media - package-name: azure-datalake-storage - clear-output-folder: true - no-namespace-folders: true -``` - -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) && $(multiapi) -batch: - - tag: package-2018-11 - - tag: package-2018-06-preview -``` - -### Tag: package-2018-11 and python - -These settings apply only when `--tag=package-2018-11 --python` is specified on the command line. - -``` yaml $(tag) == 'package-2018-11' && $(python) -python: - namespace: azure.datalake.storage.v2018_11_09 - output-folder: $(python-sdks-folder)/azure-datalake-storage/azure/datalake/storage/v2018_11_09 -``` - -### Tag: package-2018-06-preview and python - -These settings apply only when `--tag=package-2018-06-preview --python` is specified on the command line. - -``` yaml $(tag) == 'package-2018-06-preview' && $(python) -python: - namespace: azure.datalake.storage.v2018_06_17_preview - output-folder: $(python-sdks-folder)/azure-datalake-storage/azure/datalake/storage/v2018_06_17_preview -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -java: - azure-arm: true - namespace: com.microsoft.azure.storage.datalake - license-header: MICROSOFT_MIT_NO_CODEGEN - output-folder: $(azure-libraries-for-java-folder)/azure-storage-datalake -``` - -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions +``` yaml $(tag) == 'queue-package-2018-03' input-file: - - $(this-folder)/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json - - $(this-folder)/Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json - +- Microsoft.QueueStorage/preview/2018-03-28/queue.json ``` -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +### Suppression +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: These parameters are predfined by storage specifications + - suppress: XmsPathsMustOverloadPaths + - suppress: XmsExamplesRequired ``` - +--- \ No newline at end of file diff --git a/specification/storage/data-plane/readme.nodejs.md b/specification/storage/data-plane/readme.nodejs.md deleted file mode 100644 index 53d5e9b21d8d..000000000000 --- a/specification/storage/data-plane/readme.nodejs.md +++ /dev/null @@ -1,14 +0,0 @@ -## Node.js - -These settings apply only when `--nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(nodejs) -nodejs: - azure-arm: true - package-name: azure-storage-datalake - output-folder: $(node-sdks-folder)/lib/services/storageDatalake - generate-license-txt: false - generate-package-json: false - generate-readme-md: false -``` diff --git a/specification/storage/data-plane/readme.typescript.md b/specification/storage/data-plane/readme.typescript.md deleted file mode 100644 index 38f647ed7636..000000000000 --- a/specification/storage/data-plane/readme.typescript.md +++ /dev/null @@ -1,12 +0,0 @@ -## TypeScript - -These settings apply only when `--typescript` is specified on the command line. -Please also specify `--typescript-sdks-folder=`. - -``` yaml $(typescript) -typescript: - azure-arm: true - package-name: "@azure/storage-datalake" - output-folder: "$(typescript-sdks-folder)/sdk/storage/storage-datalake" - generate-metadata: true -```