From f61d2f7029a54557780f9fe33a735c08e5b04478 Mon Sep 17 00:00:00 2001 From: nickliu-msft Date: Wed, 24 Jun 2026 14:17:06 -0400 Subject: [PATCH] Paginated File Get Ranges (TypeSpec) --- .../storage/data-plane/FileStorage/client.tsp | 6 + .../examples/2026-10-06/placeholder.md | 0 .../storage/data-plane/FileStorage/main.tsp | 3 + .../storage/data-plane/FileStorage/models.tsp | 23 + .../storage/data-plane/FileStorage/readme.md | 11 +- .../storage/data-plane/FileStorage/routes.tsp | 30 + .../stable/2026-10-06/generated_file.json | 12741 ++++++++++++++++ 7 files changed, 12813 insertions(+), 1 deletion(-) create mode 100644 specification/storage/data-plane/FileStorage/examples/2026-10-06/placeholder.md create mode 100644 specification/storage/data-plane/FileStorage/stable/2026-10-06/generated_file.json diff --git a/specification/storage/data-plane/FileStorage/client.tsp b/specification/storage/data-plane/FileStorage/client.tsp index 3c31ff6bdcf1..9742fa606bb0 100644 --- a/specification/storage/data-plane/FileStorage/client.tsp +++ b/specification/storage/data-plane/FileStorage/client.tsp @@ -448,6 +448,12 @@ model SignedIdentifiersGo is Array; "python,javascript,csharp,go" ); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "This is for legacy compatibility" +@@Legacy.disablePageable( + Storage.File.File.listAllRanges, + "python,javascript,csharp,go" +); + @@alternateType(Storage.File.FileProperty.creationTime, string, "python"); @@alternateType(Storage.File.FileProperty.lastWriteTime, string, "python"); @@alternateType(Storage.File.FileProperty.changeTime, string, "python"); diff --git a/specification/storage/data-plane/FileStorage/examples/2026-10-06/placeholder.md b/specification/storage/data-plane/FileStorage/examples/2026-10-06/placeholder.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/specification/storage/data-plane/FileStorage/main.tsp b/specification/storage/data-plane/FileStorage/main.tsp index d7731ee49db0..2f8d72e5bdbb 100644 --- a/specification/storage/data-plane/FileStorage/main.tsp +++ b/specification/storage/data-plane/FileStorage/main.tsp @@ -33,4 +33,7 @@ namespace Storage.File; enum Versions { /** API Version 2026-06-06 */ v2026_06_06: "2026-06-06", + + /** API Version 2026-10-06 */ + v2026_10_06: "2026-10-06", } diff --git a/specification/storage/data-plane/FileStorage/models.tsp b/specification/storage/data-plane/FileStorage/models.tsp index 8176d588e70c..5440d1e9c9ca 100644 --- a/specification/storage/data-plane/FileStorage/models.tsp +++ b/specification/storage/data-plane/FileStorage/models.tsp @@ -1,10 +1,12 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/xml"; +import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-client-generator-core"; using TypeSpec.Http; +using TypeSpec.Versioning; using Azure.ClientGenerator.Core; namespace Storage.File; @@ -986,6 +988,27 @@ model ShareFileRangeList { clearRanges?: ClearRange[]; } +/** The paginated list of file ranges */ +@added(Versions.v2026_10_06) +@Xml.name("Ranges") +model ShareFileRangeListSegment { + /** The file ranges. */ + @pageItems + @Xml.unwrapped + @Xml.name("Range") + ranges?: FileRange[]; + + /** The clear ranges. */ + @Xml.unwrapped + @Xml.name("ClearRange") + clearRanges?: ClearRange[]; + + /** The next marker. */ + @continuationToken + @Xml.name("NextMarker") + nextMarker?: string; +} + /** * The error response. * diff --git a/specification/storage/data-plane/FileStorage/readme.md b/specification/storage/data-plane/FileStorage/readme.md index e2d8c94b3e8f..e10187d930c1 100644 --- a/specification/storage/data-plane/FileStorage/readme.md +++ b/specification/storage/data-plane/FileStorage/readme.md @@ -26,7 +26,7 @@ These are the global settings for the FileStorage API. ```yaml openapi-type: data-plane -tag: package-2026-06-tsp +tag: package-2026-10-tsp use-internal-constructors: true add-credentials: true ``` @@ -40,6 +40,15 @@ input-file: - stable/2026-06-06/generated_file.json ``` +### Tag: package-2026-10-tsp + +These settings apply only when `--tag=package-2026-10-tsp` is specified on the command line. + +``` yaml $(tag) == 'package-2026-10-tsp' +input-file: +- stable/2026-10-06/generated_file.json +``` + ### Suppression ```yaml diff --git a/specification/storage/data-plane/FileStorage/routes.tsp b/specification/storage/data-plane/FileStorage/routes.tsp index e0dafc239423..bb2b83a3db3e 100644 --- a/specification/storage/data-plane/FileStorage/routes.tsp +++ b/specification/storage/data-plane/FileStorage/routes.tsp @@ -1,9 +1,11 @@ import "@typespec/rest"; import "@typespec/http"; +import "@typespec/versioning"; import "@azure-tools/typespec-client-generator-core"; import "./models.tsp"; using TypeSpec.Http; +using TypeSpec.Versioning; using Azure.ClientGenerator.Core; namespace Storage.File; @@ -1152,6 +1154,7 @@ interface File { >; /** Returns the list of valid page ranges for a file or snapshot of a file. */ + @sharedRoute @route("?comp=rangelist") @get getRangeList is StorageOperationResponseBody< @@ -1173,6 +1176,33 @@ interface File { } >; + /** Returns a paginated list of valid page ranges for a file or snapshot of a file. */ + @added(Versions.v2026_10_06) + @sharedRoute + @route("?comp=rangelist") + @get + @list + listAllRanges is StorageOperationResponseBody< + { + ...ShareSnapshotParameter; + ...PreviousSnapshotParameter; + ...TimeoutParameter; + ...RangeHeader; + ...LeaseIdOptionalParameter; + ...AllowTrailingDotParameter; + ...FileRequestIntentParameter; + ...SupportRenameHeader; + ...MarkerParameter; + ...MaxResultsParameter; + }, + { + ...LastModifiedResponseHeader; + ...EtagResponseHeader; + ...FileContentLengthResponseHeader; + @body rangeList: ShareFileRangeListSegment; + } + >; + /** Copies a blob or file to a destination file within the storage account. */ @sharedRoute @put diff --git a/specification/storage/data-plane/FileStorage/stable/2026-10-06/generated_file.json b/specification/storage/data-plane/FileStorage/stable/2026-10-06/generated_file.json new file mode 100644 index 000000000000..08490df47a47 --- /dev/null +++ b/specification/storage/data-plane/FileStorage/stable/2026-10-06/generated_file.json @@ -0,0 +1,12741 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure File Storage", + "version": "2026-10-06", + "description": "Azure File Storage provides scalable file shares in the cloud using SMB and NFS protocols.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "parameters": [ + { + "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", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/xml", + "application/json" + ], + "consumes": [ + "application/xml", + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://storage.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://storage.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/": { + "get": { + "operationId": "File_Download", + "description": "Reads or downloads a file from the system, including its metadata and properties.", + "produces": [ + "application/octet-stream", + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "Range", + "in": "header", + "description": "Return file data only from the specified byte range.", + "required": false, + "type": "string", + "x-ms-client-name": "range" + }, + { + "name": "x-ms-range-get-content-md5", + "in": "header", + "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.", + "required": false, + "type": "boolean", + "x-ms-client-name": "rangeGetContentMD5" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-structured-body", + "in": "header", + "description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties.", + "required": false, + "type": "string", + "x-ms-client-name": "structuredBodyType" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + }, + "headers": { + "Accept-Ranges": { + "type": "string" + }, + "Cache-Control": { + "type": "string", + "description": "The cache control of the file." + }, + "Content-Disposition": { + "type": "string", + "description": "The content disposition of the file." + }, + "Content-Encoding": { + "type": "string", + "description": "The content encoding of the file." + }, + "Content-Language": { + "type": "string", + "description": "The content language of the file." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "Content length of the file." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "An MD5 hash returned for the content." + }, + "Content-Range": { + "type": "string" + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-content-md5": { + "type": "string", + "format": "byte", + "description": "The MD5 hash of the full file content." + }, + "x-ms-copy-completion-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Conclusion time of the last attempted Copy File operation." + }, + "x-ms-copy-id": { + "type": "string", + "description": "String identifier for the last attempted Copy File operation." + }, + "x-ms-copy-progress": { + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source." + }, + "x-ms-copy-source": { + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file." + }, + "x-ms-copy-status": { + "type": "string", + "description": "State of the copy operation identified by x-ms-copy-id.", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": false, + "values": [ + { + "name": "Pending", + "value": "pending", + "description": "The copy operation is pending." + }, + { + "name": "Success", + "value": "success", + "description": "The copy operation succeeded." + }, + { + "name": "Aborted", + "value": "aborted", + "description": "The copy operation was aborted." + }, + { + "name": "Failed", + "value": "failed", + "description": "The copy operation failed." + } + ] + } + }, + "x-ms-copy-status-description": { + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-lease-duration": { + "type": "string", + "description": "The lease duration." + }, + "x-ms-lease-state": { + "type": "string", + "description": "The lease state." + }, + "x-ms-lease-status": { + "type": "string", + "description": "The lease status." + }, + "x-ms-link-count": { + "type": "integer", + "format": "int32", + "description": "NFS only. The link count." + }, + "x-ms-meta": { + "type": "string", + "description": "Optional. User-defined metadata for the resource." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-server-encrypted": { + "type": "boolean", + "description": "The value of this header indicates whether the file data and application metadata are completely encrypted." + }, + "x-ms-structured-body": { + "type": "string", + "description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties." + }, + "x-ms-structured-content-length": { + "type": "integer", + "format": "int64", + "description": "Structured content length." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "206": { + "description": "Successful", + "schema": { + "type": "file" + }, + "headers": { + "Accept-Ranges": { + "type": "string" + }, + "Cache-Control": { + "type": "string", + "description": "The cache control of the file." + }, + "Content-Disposition": { + "type": "string", + "description": "The content disposition of the file." + }, + "Content-Encoding": { + "type": "string", + "description": "The content encoding of the file." + }, + "Content-Language": { + "type": "string", + "description": "The content language of the file." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "Content length of the file." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "An MD5 hash returned for the content." + }, + "Content-Range": { + "type": "string" + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-content-md5": { + "type": "string", + "format": "byte", + "description": "The MD5 hash of the full file content." + }, + "x-ms-copy-completion-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Conclusion time of the last attempted Copy File operation." + }, + "x-ms-copy-id": { + "type": "string", + "description": "String identifier for the last attempted Copy File operation." + }, + "x-ms-copy-progress": { + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source." + }, + "x-ms-copy-source": { + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file." + }, + "x-ms-copy-status": { + "type": "string", + "description": "State of the copy operation identified by x-ms-copy-id.", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": false, + "values": [ + { + "name": "Pending", + "value": "pending", + "description": "The copy operation is pending." + }, + { + "name": "Success", + "value": "success", + "description": "The copy operation succeeded." + }, + { + "name": "Aborted", + "value": "aborted", + "description": "The copy operation was aborted." + }, + { + "name": "Failed", + "value": "failed", + "description": "The copy operation failed." + } + ] + } + }, + "x-ms-copy-status-description": { + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-lease-duration": { + "type": "string", + "description": "The lease duration." + }, + "x-ms-lease-state": { + "type": "string", + "description": "The lease state." + }, + "x-ms-lease-status": { + "type": "string", + "description": "The lease status." + }, + "x-ms-link-count": { + "type": "integer", + "format": "int32", + "description": "NFS only. The link count." + }, + "x-ms-meta": { + "type": "string", + "description": "Optional. User-defined metadata for the resource." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-server-encrypted": { + "type": "boolean", + "description": "The value of this header indicates whether the file data and application metadata are completely encrypted." + }, + "x-ms-structured-body": { + "type": "string", + "description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties." + }, + "x-ms-structured-content-length": { + "type": "integer", + "format": "int64", + "description": "Structured content length." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + }, + "put": { + "operationId": "File_Create", + "description": "Creates a new file or replaces a file. Note it only initializes the file with no content.", + "produces": [ + "application/xml" + ], + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-content-length", + "in": "header", + "description": "Specifies the maximum size for the file, up to 4 TB.", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-client-name": "fileContentLength" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-type", + "in": "header", + "description": "Dummy type header, must be \"file\".", + "required": true, + "type": "string", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "fileType" + }, + { + "name": "x-ms-content-type", + "in": "header", + "description": "Sets the MIME content type of the file. The default type is 'application/octet-stream'.", + "required": false, + "type": "string", + "x-ms-client-name": "fileContentType" + }, + { + "name": "x-ms-content-encoding", + "in": "header", + "description": "Specifies which content encodings have been applied to the file.", + "required": false, + "type": "string", + "x-ms-client-name": "fileContentEncoding" + }, + { + "name": "x-ms-content-language", + "in": "header", + "description": "Specifies the natural languages used by this resource.", + "required": false, + "type": "string", + "x-ms-client-name": "fileContentLanguage" + }, + { + "name": "x-ms-cache-control", + "in": "header", + "description": "Sets the file's cache control. The File service stores this value but does not use or modify it.", + "required": false, + "type": "string", + "x-ms-client-name": "fileCacheControl" + }, + { + "name": "x-ms-content-md5", + "in": "header", + "description": "An MD5 hash of the file content. This hash is used to verify the integrity of the file during transport.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "fileContentMD5" + }, + { + "name": "x-ms-content-disposition", + "in": "header", + "description": "Sets the file's Content-Disposition header.", + "required": false, + "type": "string", + "x-ms-client-name": "fileContentDisposition" + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-file-permission", + "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-client-name": "filePermission" + }, + { + "name": "x-ms-file-permission-key", + "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-client-name": "filePermissionKey" + }, + { + "name": "x-ms-file-attributes", + "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": false, + "type": "string", + "x-ms-client-name": "fileAttributes" + }, + { + "name": "x-ms-file-creation-time", + "in": "header", + "description": "Creation time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileCreationTime" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "Last write time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileLastWriteTime" + }, + { + "name": "x-ms-file-change-time", + "in": "header", + "description": "Change time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileChangeTime" + }, + { + "name": "x-ms-file-permission-format", + "in": "header", + "description": "Optional. Used to set permission format.", + "required": false, + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false, + "values": [ + { + "name": "Sddl", + "value": "Sddl", + "description": "Sddl" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Binary" + } + ] + }, + "x-ms-client-name": "filePermissionFormat" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-owner", + "in": "header", + "description": "Optional, NFS only. The owner of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "owner" + }, + { + "name": "x-ms-group", + "in": "header", + "description": "Optional, NFS only. The owning group of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "group" + }, + { + "name": "x-ms-mode", + "in": "header", + "description": "Optional, NFS only. The file mode of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "fileMode" + }, + { + "name": "x-ms-file-file-type", + "in": "header", + "description": "Optional, NFS only. Type of the file or directory.", + "required": false, + "type": "string", + "enum": [ + "Regular", + "Directory", + "SymLink" + ], + "x-ms-enum": { + "name": "NfsFileType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular" + }, + { + "name": "Directory", + "value": "Directory", + "description": "Directory" + }, + { + "name": "SymLink", + "value": "SymLink", + "description": "SymLink" + } + ] + }, + "x-ms-client-name": "nfsFileType" + }, + { + "name": "Content-MD5", + "in": "header", + "description": "An MD5 hash of the content. This hash is used to verify the integrity of the data during transport.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "contentMD5" + }, + { + "name": "x-ms-file-property-semantics", + "in": "header", + "description": "SMB only. Default value is New.", + "required": false, + "type": "string", + "enum": [ + "New", + "Restore" + ], + "x-ms-enum": { + "name": "FilePropertySemantics", + "modelAsString": true, + "values": [ + { + "name": "New", + "value": "New", + "description": "New" + }, + { + "name": "Restore", + "value": "Restore", + "description": "Restore" + } + ] + }, + "x-ms-client-name": "filePropertySemantics" + }, + { + "name": "Content-Length", + "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": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "contentLength" + }, + { + "name": "x-ms-structured-body", + "in": "header", + "description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties.", + "required": false, + "type": "string", + "x-ms-client-name": "structuredBodyType" + }, + { + "name": "x-ms-structured-content-length", + "in": "header", + "description": "Required if the request body is a structured message. Specifies the length of the blob/file content inside the message body. Will always be smaller than Content-Length.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "structuredContentLength" + }, + { + "name": "optionalBody", + "in": "body", + "description": "Initial data.", + "required": false, + "schema": { + "type": "string", + "format": "binary" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "Content length of the file." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "An MD5 hash returned for the content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-file-type": { + "type": "string", + "description": "NFS only. The file type.", + "enum": [ + "Regular", + "Directory", + "SymLink" + ], + "x-ms-enum": { + "name": "NfsFileType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular" + }, + { + "name": "Directory", + "value": "Directory", + "description": "Directory" + }, + { + "name": "SymLink", + "value": "SymLink", + "description": "SymLink" + } + ] + } + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-structured-body": { + "type": "string", + "description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + }, + "delete": { + "operationId": "File_Delete", + "description": "Removes the file from the storage account.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-link-count": { + "type": "integer", + "format": "int32", + "description": "NFS only. The link count." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + }, + "head": { + "operationId": "File_GetProperties", + "description": "Returns all user-defined metadata, standard HTTP properties, and system properties for the file.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Cache-Control": { + "type": "string", + "description": "The cache control of the file." + }, + "Content-Disposition": { + "type": "string", + "description": "The content disposition of the file." + }, + "Content-Encoding": { + "type": "string", + "description": "The content encoding of the file." + }, + "Content-Language": { + "type": "string", + "description": "The content language of the file." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "Content length of the file." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "An MD5 hash returned for the content." + }, + "Content-Type": { + "type": "string" + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-copy-completion-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Conclusion time of the last attempted Copy File operation." + }, + "x-ms-copy-id": { + "type": "string", + "description": "String identifier for the last attempted Copy File operation." + }, + "x-ms-copy-progress": { + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source." + }, + "x-ms-copy-source": { + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file." + }, + "x-ms-copy-status": { + "type": "string", + "description": "State of the copy operation identified by x-ms-copy-id.", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": false, + "values": [ + { + "name": "Pending", + "value": "pending", + "description": "The copy operation is pending." + }, + { + "name": "Success", + "value": "success", + "description": "The copy operation succeeded." + }, + { + "name": "Aborted", + "value": "aborted", + "description": "The copy operation was aborted." + }, + { + "name": "Failed", + "value": "failed", + "description": "The copy operation failed." + } + ] + } + }, + "x-ms-copy-status-description": { + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-file-type": { + "type": "string", + "description": "NFS only. The file type.", + "enum": [ + "Regular", + "Directory", + "SymLink" + ], + "x-ms-enum": { + "name": "NfsFileType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular" + }, + { + "name": "Directory", + "value": "Directory", + "description": "Directory" + }, + { + "name": "SymLink", + "value": "SymLink", + "description": "SymLink" + } + ] + } + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-lease-duration": { + "type": "string", + "description": "The lease duration." + }, + "x-ms-lease-state": { + "type": "string", + "description": "The lease state." + }, + "x-ms-lease-status": { + "type": "string", + "description": "The lease status." + }, + "x-ms-link-count": { + "type": "integer", + "format": "int32", + "description": "NFS only. The link count." + }, + "x-ms-meta": { + "type": "string", + "description": "Optional. User-defined metadata for the resource." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-server-encrypted": { + "type": "boolean", + "description": "The value of this header indicates whether the file data and application metadata are completely encrypted." + }, + "x-ms-type": { + "type": "string", + "description": "Dummy type header, must be \"file\".", + "enum": [ + "File" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + } + }, + "x-ms-paths": { + "?comp=copy": { + "put": { + "operationId": "File_AbortCopy", + "description": "Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-copy-action", + "in": "header", + "description": "Must be the literal \"abort\" to abort the pending copy operation.", + "required": true, + "type": "string", + "enum": [ + "abort" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "copyActionAbortConstant" + }, + { + "name": "copyid", + "in": "query", + "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy File operation.", + "required": true, + "type": "string" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. ", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=forceclosehandles": { + "put": { + "operationId": "Directory_ForceCloseHandles", + "description": "Closes all handles open for given directory.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-handle-id", + "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-client-name": "handleId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next listing operation.", + "required": false, + "type": "string" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-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-client-name": "recursive" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-marker": { + "type": "string", + "description": "A string describing next handle to be closed." + }, + "x-ms-number-of-handles-closed": { + "type": "integer", + "format": "int32" + }, + "x-ms-number-of-handles-failed": { + "type": "integer", + "format": "int32" + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=forceclosehandles&_overload=forceCloseHandles": { + "put": { + "operationId": "File_ForceCloseHandles", + "description": "Closes all handles open for given file.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-handle-id", + "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-client-name": "handleId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next listing operation.", + "required": false, + "type": "string" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-marker": { + "type": "string", + "description": "A string describing next handle to be closed." + }, + "x-ms-number-of-handles-closed": { + "type": "integer", + "format": "int32" + }, + "x-ms-number-of-handles-failed": { + "type": "integer", + "format": "int32" + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=lease": { + "put": { + "operationId": "File_AcquireLease", + "description": "The Lease File operation establishes and manages a lock on a file for write and delete operations.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-duration", + "in": "header", + "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.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-client-name": "leaseDuration" + }, + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "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.", + "required": false, + "type": "string", + "x-ms-client-name": "proposedLeaseId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Describes what lease action to take.", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "action" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-lease-id": { + "type": "string", + "description": "If specified, the lease ID must match the lease ID of the file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=lease&_overload=breakLease": { + "put": { + "operationId": "File_BreakLease", + "description": "The Lease File operation establishes and manages a lock on a file for write and delete operations.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Describes what lease action to take.", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "action" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-lease-id": { + "type": "string", + "description": "If specified, the lease ID must match the lease ID of the file." + }, + "x-ms-lease-time": { + "type": "integer", + "format": "int32", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=lease&_overload=changeLease": { + "put": { + "operationId": "File_ChangeLease", + "description": "The Lease File operation establishes and manages a lock on a file for write and delete operations.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Specifies the current lease ID on the resource.", + "required": true, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "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.", + "required": false, + "type": "string", + "x-ms-client-name": "proposedLeaseId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Describes what lease action to take.", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "action" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-lease-id": { + "type": "string", + "description": "If specified, the lease ID must match the lease ID of the file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=lease&_overload=releaseLease": { + "put": { + "operationId": "File_ReleaseLease", + "description": "The Lease File operation establishes and manages a lock on a file for write and delete operations.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Specifies the current lease ID on the resource.", + "required": true, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Describes what lease action to take.", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "action" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=listhandles": { + "get": { + "operationId": "Directory_ListHandles", + "description": "Lists handles for directory.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next listing operation.", + "required": false, + "type": "string" + }, + { + "name": "maxresults", + "in": "query", + "description": "Specifies the maximum number of items to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-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-client-name": "recursive" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListHandlesResponse" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=listhandles&_overload=listHandles": { + "get": { + "operationId": "File_ListHandles", + "description": "Lists handles for file.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next listing operation.", + "required": false, + "type": "string" + }, + { + "name": "maxresults", + "in": "query", + "description": "Specifies the maximum number of items to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListHandlesResponse" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=metadata": { + "put": { + "operationId": "File_SetMetadata", + "description": "Sets one or more user-defined name-value pairs for the specified file.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=properties": { + "put": { + "operationId": "File_SetHttpHeaders", + "description": "Sets HTTP headers on a file.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-content-length", + "in": "header", + "description": "Specifies the number of bytes being transmitted.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "fileContentLength" + }, + { + "name": "x-ms-content-type", + "in": "header", + "description": "Sets the MIME content type of the file. The default type is 'application/octet-stream'.", + "required": false, + "type": "string", + "x-ms-client-name": "fileContentType" + }, + { + "name": "x-ms-content-encoding", + "in": "header", + "description": "Specifies which content encodings have been applied to the file.", + "required": false, + "type": "string", + "x-ms-client-name": "fileContentEncoding" + }, + { + "name": "x-ms-content-language", + "in": "header", + "description": "Specifies the natural languages used by this resource.", + "required": false, + "type": "string", + "x-ms-client-name": "fileContentLanguage" + }, + { + "name": "x-ms-cache-control", + "in": "header", + "description": "Sets the file's cache control. The File service stores this value but does not use or modify it.", + "required": false, + "type": "string", + "x-ms-client-name": "fileCacheControl" + }, + { + "name": "x-ms-content-md5", + "in": "header", + "description": "An MD5 hash of the file content. This hash is used to verify the integrity of the file during transport.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "fileContentMD5" + }, + { + "name": "x-ms-content-disposition", + "in": "header", + "description": "Sets the file's Content-Disposition header.", + "required": false, + "type": "string", + "x-ms-client-name": "fileContentDisposition" + }, + { + "name": "x-ms-file-permission", + "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-client-name": "filePermission" + }, + { + "name": "x-ms-file-permission-key", + "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-client-name": "filePermissionKey" + }, + { + "name": "x-ms-file-attributes", + "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": false, + "type": "string", + "x-ms-client-name": "fileAttributes" + }, + { + "name": "x-ms-file-creation-time", + "in": "header", + "description": "Creation time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileCreationTime" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "Last write time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileLastWriteTime" + }, + { + "name": "x-ms-file-change-time", + "in": "header", + "description": "Change time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileChangeTime" + }, + { + "name": "x-ms-file-permission-format", + "in": "header", + "description": "Optional. Used to set permission format.", + "required": false, + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false, + "values": [ + { + "name": "Sddl", + "value": "Sddl", + "description": "Sddl" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Binary" + } + ] + }, + "x-ms-client-name": "filePermissionFormat" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-owner", + "in": "header", + "description": "Optional, NFS only. The owner of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "owner" + }, + { + "name": "x-ms-group", + "in": "header", + "description": "Optional, NFS only. The owning group of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "group" + }, + { + "name": "x-ms-mode", + "in": "header", + "description": "Optional, NFS only. The file mode of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "fileMode" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-link-count": { + "type": "integer", + "format": "int32", + "description": "NFS only. The link count." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=range": { + "put": { + "operationId": "File_UploadRange", + "description": "Upload a range of bytes to a file.", + "produces": [ + "application/xml" + ], + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "Range", + "in": "header", + "description": "Specifies the range of bytes to be written. Both the start and end of the range must be specified.", + "required": true, + "type": "string", + "x-ms-client-name": "range" + }, + { + "name": "x-ms-write", + "in": "header", + "description": "Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. - Clear: Clears the specified range and releases the space used in storage for that range.", + "required": true, + "type": "string", + "default": "update", + "enum": [ + "update", + "clear" + ], + "x-ms-enum": { + "name": "FileRangeWriteType", + "modelAsString": false, + "values": [ + { + "name": "update", + "value": "update", + "description": "Writes the bytes specified by the request body into the specified range." + }, + { + "name": "clear", + "value": "clear", + "description": "Clears the specified range and releases the space used in storage for that range." + } + ] + }, + "x-ms-client-name": "fileRangeWrite" + }, + { + "name": "Content-Length", + "in": "header", + "description": "The number of bytes being transmitted in the request body.", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-client-name": "contentLength" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "Content-MD5", + "in": "header", + "description": "An MD5 hash of the content. This hash is used to verify the integrity of the data during transport.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "contentMD5" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "If the file last write time should be preserved or overwritten.", + "required": false, + "type": "string", + "enum": [ + "Now", + "Preserve" + ], + "x-ms-enum": { + "name": "FileLastWrittenMode", + "modelAsString": false, + "values": [ + { + "name": "Now", + "value": "Now", + "description": "Now" + }, + { + "name": "Preserve", + "value": "Preserve", + "description": "Preserve" + } + ] + }, + "x-ms-client-name": "fileLastWrittenMode" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-structured-body", + "in": "header", + "description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties.", + "required": false, + "type": "string", + "x-ms-client-name": "structuredBodyType" + }, + { + "name": "x-ms-structured-content-length", + "in": "header", + "description": "Required if the request body is a structured message. Specifies the length of the blob/file content inside the message body. Will always be smaller than Content-Length.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "structuredContentLength" + }, + { + "name": "optionalBody", + "in": "body", + "description": "Initial data.", + "required": false, + "schema": { + "type": "string", + "format": "binary" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "An MD5 hash returned for the content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "The file last write time." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-structured-body": { + "type": "string", + "description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=range&_overload=uploadRangeFromUrl": { + "put": { + "operationId": "File_UploadRangeFromUrl", + "description": "Upload a range of bytes to a file where the contents are read from a URL.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "Range", + "in": "header", + "description": "Specifies the range of bytes to be written. Both the start and end of the range must be specified.", + "required": true, + "type": "string", + "x-ms-client-name": "range" + }, + { + "name": "x-ms-copy-source", + "in": "header", + "description": "Specifies the URL of the source file or blob, up to 2 KB in length.", + "required": true, + "type": "string", + "x-ms-client-name": "copySource" + }, + { + "name": "x-ms-source-range", + "in": "header", + "description": "Bytes of source data in the specified range.", + "required": false, + "type": "string", + "x-ms-client-name": "sourceRange" + }, + { + "name": "x-ms-write", + "in": "header", + "description": "Only update is supported.", + "required": true, + "type": "string", + "default": "update", + "enum": [ + "update" + ], + "x-ms-enum": { + "name": "FileRangeWriteFromUrlType", + "modelAsString": false, + "values": [ + { + "name": "update", + "value": "update", + "description": "Writes the bytes specified by the source URL into the specified range." + } + ] + }, + "x-ms-client-name": "fileRangeWriteFromUrl" + }, + { + "name": "Content-Length", + "in": "header", + "description": "The number of bytes being transmitted in the request body.", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-client-name": "contentLength" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-source-content-crc64", + "in": "header", + "description": "Specify the CRC64 hash of the source content.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "sourceContentCrc64" + }, + { + "name": "x-ms-source-if-match-crc64", + "in": "header", + "description": "Specify the CRC64 hash value to check for source content integrity.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "sourceIfMatchCrc64" + }, + { + "name": "x-ms-source-if-none-match-crc64", + "in": "header", + "description": "Specify the CRC64 hash value to check for source content mismatch.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "sourceIfNoneMatchCrc64" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-copy-source-authorization", + "in": "header", + "description": "Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.", + "required": false, + "type": "string", + "x-ms-client-name": "copySourceAuthorization" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "If the file last write time should be preserved or overwritten.", + "required": false, + "type": "string", + "enum": [ + "Now", + "Preserve" + ], + "x-ms-enum": { + "name": "FileLastWrittenMode", + "modelAsString": false, + "values": [ + { + "name": "Now", + "value": "Now", + "description": "Now" + }, + { + "name": "Preserve", + "value": "Preserve", + "description": "Preserve" + } + ] + }, + "x-ms-client-name": "fileLastWrittenMode" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-source-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the source URI.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowSourceTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "An MD5 hash returned for the content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "CRC64 hash of the range content." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "The file last write time." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=rangelist": { + "get": { + "operationId": "File_GetRangeList", + "description": "Returns the list of valid page ranges for a file or snapshot of a file.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "prevsharesnapshot", + "in": "query", + "description": "The previous snapshot parameter is an opaque DateTime value that specifies a previous file snapshot to compare against.", + "required": false, + "type": "string" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "Range", + "in": "header", + "description": "Return file data only from the specified byte range.", + "required": false, + "type": "string", + "x-ms-client-name": "range" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-file-support-rename", + "in": "header", + "description": "This header is allowed only when PrevShareSnapshot query parameter is set. Determines whether the changed ranges for a file that has been renamed or moved should be listed.", + "required": false, + "type": "boolean", + "x-ms-client-name": "supportRename" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ShareFileRangeList" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-content-length": { + "type": "integer", + "format": "int64", + "description": "The length of the file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=rangelist&_overload=listAllRanges": { + "get": { + "operationId": "File_ListAllRanges", + "description": "Returns a paginated list of valid page ranges for a file or snapshot of a file.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "prevsharesnapshot", + "in": "query", + "description": "The previous snapshot parameter is an opaque DateTime value that specifies a previous file snapshot to compare against.", + "required": false, + "type": "string" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "Range", + "in": "header", + "description": "Return file data only from the specified byte range.", + "required": false, + "type": "string", + "x-ms-client-name": "range" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-file-support-rename", + "in": "header", + "description": "This header is allowed only when PrevShareSnapshot query parameter is set. Determines whether the changed ranges for a file that has been renamed or moved should be listed.", + "required": false, + "type": "boolean", + "x-ms-client-name": "supportRename" + }, + { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next listing operation.", + "required": false, + "type": "string" + }, + { + "name": "maxresults", + "in": "query", + "description": "Specifies the maximum number of items to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ShareFileRangeListSegment" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-content-length": { + "type": "integer", + "format": "int64", + "description": "The length of the file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?comp=rename": { + "put": { + "operationId": "File_Rename", + "description": "Renames a file. By default, the destination is overwritten and if the destination already exists and has a read-only attribute set, the operation will fail.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-rename-source", + "in": "header", + "description": "Required. Specifies the URI-style path of the source file, up to 2 KB in length.", + "required": true, + "type": "string", + "x-ms-client-name": "renameSource" + }, + { + "name": "x-ms-file-rename-replace-if-exists", + "in": "header", + "description": "Boolean. Default value is false. Set to true to indicate that the destination should be overwritten.", + "required": false, + "type": "boolean", + "x-ms-client-name": "replaceIfExists" + }, + { + "name": "x-ms-file-rename-ignore-readonly", + "in": "header", + "description": "Boolean. Default value is false. Set to true to overwrite the destination even if it has the read-only attribute set.", + "required": false, + "type": "boolean", + "x-ms-client-name": "ignoreReadOnly" + }, + { + "name": "x-ms-source-lease-id", + "in": "header", + "description": "Required if the source file has an active lease.", + "required": false, + "type": "string", + "x-ms-client-name": "sourceLeaseId" + }, + { + "name": "x-ms-destination-lease-id", + "in": "header", + "description": "Required if the destination has an active lease.", + "required": false, + "type": "string", + "x-ms-client-name": "destinationLeaseId" + }, + { + "name": "x-ms-file-attributes", + "in": "header", + "description": "If specified, the provided file attributes shall be set.", + "required": false, + "type": "string", + "x-ms-client-name": "fileAttributes" + }, + { + "name": "x-ms-file-creation-time", + "in": "header", + "description": "Creation time for the file.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileCreationTime" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "Last write time for the file.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileLastWriteTime" + }, + { + "name": "x-ms-file-change-time", + "in": "header", + "description": "Change time for the file.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileChangeTime" + }, + { + "name": "x-ms-file-permission", + "in": "header", + "description": "If specified the permission shall be set for the file.", + "required": false, + "type": "string", + "x-ms-client-name": "filePermission" + }, + { + "name": "x-ms-file-permission-format", + "in": "header", + "description": "Optional. Used to set permission format.", + "required": false, + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false, + "values": [ + { + "name": "Sddl", + "value": "Sddl", + "description": "Sddl" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Binary" + } + ] + }, + "x-ms-client-name": "filePermissionFormat" + }, + { + "name": "x-ms-file-permission-key", + "in": "header", + "description": "Key of the permission to be set.", + "required": false, + "type": "string", + "x-ms-client-name": "filePermissionKey" + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-content-type", + "in": "header", + "description": "Sets the MIME content type of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "fileContentType" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-source-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the source URI.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowSourceTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=directory": { + "put": { + "operationId": "Directory_Create", + "description": "Creates a new directory under the specified share or parent directory.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-file-permission", + "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-client-name": "filePermission" + }, + { + "name": "x-ms-file-permission-key", + "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-client-name": "filePermissionKey" + }, + { + "name": "x-ms-file-attributes", + "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": false, + "type": "string", + "x-ms-client-name": "fileAttributes" + }, + { + "name": "x-ms-file-creation-time", + "in": "header", + "description": "Creation time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileCreationTime" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "Last write time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileLastWriteTime" + }, + { + "name": "x-ms-file-change-time", + "in": "header", + "description": "Change time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileChangeTime" + }, + { + "name": "x-ms-file-permission-format", + "in": "header", + "description": "Optional. Used to set permission format.", + "required": false, + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false, + "values": [ + { + "name": "Sddl", + "value": "Sddl", + "description": "Sddl" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Binary" + } + ] + }, + "x-ms-client-name": "filePermissionFormat" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-owner", + "in": "header", + "description": "Optional, NFS only. The owner of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "owner" + }, + { + "name": "x-ms-group", + "in": "header", + "description": "Optional, NFS only. The owning group of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "group" + }, + { + "name": "x-ms-mode", + "in": "header", + "description": "Optional, NFS only. The file mode of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "fileMode" + }, + { + "name": "x-ms-file-property-semantics", + "in": "header", + "description": "SMB only. Default value is New.", + "required": false, + "type": "string", + "enum": [ + "New", + "Restore" + ], + "x-ms-enum": { + "name": "FilePropertySemantics", + "modelAsString": true, + "values": [ + { + "name": "New", + "value": "New", + "description": "New" + }, + { + "name": "Restore", + "value": "Restore", + "description": "Restore" + } + ] + }, + "x-ms-client-name": "filePropertySemantics" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-file-type": { + "type": "string", + "description": "NFS only. The file type.", + "enum": [ + "Regular", + "Directory", + "SymLink" + ], + "x-ms-enum": { + "name": "NfsFileType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular" + }, + { + "name": "Directory", + "value": "Directory", + "description": "Directory" + }, + { + "name": "SymLink", + "value": "SymLink", + "description": "SymLink" + } + ] + } + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=directory&_overload=delete": { + "delete": { + "operationId": "Directory_Delete", + "description": "Removes the specified empty directory. Note that the directory must be empty before it can be deleted.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=directory&_overload=getProperties": { + "get": { + "operationId": "Directory_GetProperties", + "description": "Returns all system properties for the specified directory, and can also be used to check the existence of a directory.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-file-type": { + "type": "string", + "description": "NFS only. The file type.", + "enum": [ + "Regular", + "Directory", + "SymLink" + ], + "x-ms-enum": { + "name": "NfsFileType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular" + }, + { + "name": "Directory", + "value": "Directory", + "description": "Directory" + }, + { + "name": "SymLink", + "value": "SymLink", + "description": "SymLink" + } + ] + } + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-meta": { + "type": "string", + "description": "Optional. User-defined metadata for the resource." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-server-encrypted": { + "type": "boolean", + "description": "The value of this header indicates whether the file data and application metadata are completely encrypted." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=directory&comp=list": { + "get": { + "operationId": "Directory_ListFilesAndDirectoriesSegment", + "description": "Returns a list of files and directories under the specified share or directory. It lists the contents only for a single level of the directory hierarchy.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "prefix", + "in": "query", + "description": "Filters the results to return only items whose name begins with the specified prefix.", + "required": false, + "type": "string" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next listing operation.", + "required": false, + "type": "string" + }, + { + "name": "maxresults", + "in": "query", + "description": "Specifies the maximum number of items to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "Timestamps", + "Etag", + "Attributes", + "PermissionKey" + ], + "x-ms-enum": { + "name": "ListFilesIncludeType", + "modelAsString": false, + "values": [ + { + "name": "Timestamps", + "value": "Timestamps", + "description": "Timestamps" + }, + { + "name": "Etag", + "value": "Etag", + "description": "Etag" + }, + { + "name": "Attributes", + "value": "Attributes", + "description": "Attributes" + }, + { + "name": "PermissionKey", + "value": "PermissionKey", + "description": "PermissionKey" + } + ] + } + }, + "collectionFormat": "csv" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-extended-info", + "in": "header", + "description": "Include extended information.", + "required": false, + "type": "boolean", + "x-ms-client-name": "includeExtendedInfo" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListFilesAndDirectoriesSegmentResponse" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=directory&comp=metadata": { + "put": { + "operationId": "Directory_SetMetadata", + "description": "Sets one or more user-defined name-value pairs for the specified directory.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=directory&comp=properties": { + "put": { + "operationId": "Directory_SetProperties", + "description": "Sets properties for the specified directory.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-permission", + "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-client-name": "filePermission" + }, + { + "name": "x-ms-file-permission-key", + "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-client-name": "filePermissionKey" + }, + { + "name": "x-ms-file-attributes", + "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": false, + "type": "string", + "x-ms-client-name": "fileAttributes" + }, + { + "name": "x-ms-file-creation-time", + "in": "header", + "description": "Creation time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileCreationTime" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "Last write time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileLastWriteTime" + }, + { + "name": "x-ms-file-change-time", + "in": "header", + "description": "Change time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileChangeTime" + }, + { + "name": "x-ms-file-permission-format", + "in": "header", + "description": "Optional. Used to set permission format.", + "required": false, + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false, + "values": [ + { + "name": "Sddl", + "value": "Sddl", + "description": "Sddl" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Binary" + } + ] + }, + "x-ms-client-name": "filePermissionFormat" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-owner", + "in": "header", + "description": "Optional, NFS only. The owner of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "owner" + }, + { + "name": "x-ms-group", + "in": "header", + "description": "Optional, NFS only. The owning group of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "group" + }, + { + "name": "x-ms-mode", + "in": "header", + "description": "Optional, NFS only. The file mode of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "fileMode" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=directory&comp=rename": { + "put": { + "operationId": "Directory_Rename", + "description": "Renames a directory. By default, the destination is overwritten and if the destination already exists and has a read-only attribute set, the operation will fail.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-rename-source", + "in": "header", + "description": "Required. Specifies the URI-style path of the source file, up to 2 KB in length.", + "required": true, + "type": "string", + "x-ms-client-name": "renameSource" + }, + { + "name": "x-ms-file-rename-replace-if-exists", + "in": "header", + "description": "Boolean. Default value is false. Set to true to indicate that the destination should be overwritten.", + "required": false, + "type": "boolean", + "x-ms-client-name": "replaceIfExists" + }, + { + "name": "x-ms-file-rename-ignore-readonly", + "in": "header", + "description": "Boolean. Default value is false. Set to true to overwrite the destination even if it has the read-only attribute set.", + "required": false, + "type": "boolean", + "x-ms-client-name": "ignoreReadOnly" + }, + { + "name": "x-ms-source-lease-id", + "in": "header", + "description": "Required if the source file has an active lease.", + "required": false, + "type": "string", + "x-ms-client-name": "sourceLeaseId" + }, + { + "name": "x-ms-destination-lease-id", + "in": "header", + "description": "Required if the destination has an active lease.", + "required": false, + "type": "string", + "x-ms-client-name": "destinationLeaseId" + }, + { + "name": "x-ms-file-attributes", + "in": "header", + "description": "If specified, the provided file attributes shall be set.", + "required": false, + "type": "string", + "x-ms-client-name": "fileAttributes" + }, + { + "name": "x-ms-file-creation-time", + "in": "header", + "description": "Creation time for the directory.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileCreationTime" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "Last write time for the directory.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileLastWriteTime" + }, + { + "name": "x-ms-file-change-time", + "in": "header", + "description": "Change time for the directory.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileChangeTime" + }, + { + "name": "x-ms-file-permission", + "in": "header", + "description": "If specified the permission shall be set for the directory.", + "required": false, + "type": "string", + "x-ms-client-name": "filePermission" + }, + { + "name": "x-ms-file-permission-format", + "in": "header", + "description": "Optional. Used to set permission format.", + "required": false, + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false, + "values": [ + { + "name": "Sddl", + "value": "Sddl", + "description": "Sddl" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Binary" + } + ] + }, + "x-ms-client-name": "filePermissionFormat" + }, + { + "name": "x-ms-file-permission-key", + "in": "header", + "description": "Key of the permission to be set.", + "required": false, + "type": "string", + "x-ms-client-name": "filePermissionKey" + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-source-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the source URI.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowSourceTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-attributes": { + "type": "string", + "description": "Attributes set for the file/directory." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "Change time for the file/directory." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "Creation time for the file/directory." + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the directory/file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "Last write time for the file/directory." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the directory/file." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-request-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=hardlink": { + "put": { + "operationId": "File_CreateHardLink", + "description": "Creates a hard link to a target file. NFS only.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-type", + "in": "header", + "description": "Dummy type header, must be \"file\".", + "required": true, + "type": "string", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "fileType" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-file-target-file", + "in": "header", + "description": "NFS only. Required. Specifies the path of the target file to which the link will be created, up to 2 KiB in length.", + "required": true, + "type": "string", + "x-ms-client-name": "targetFile" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "The file change time." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "The file creation time." + }, + "x-ms-file-file-type": { + "type": "string", + "description": "NFS only. The file type.", + "enum": [ + "Regular", + "Directory", + "SymLink" + ], + "x-ms-enum": { + "name": "NfsFileType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular" + }, + { + "name": "Directory", + "value": "Directory", + "description": "Directory" + }, + { + "name": "SymLink", + "value": "SymLink", + "description": "SymLink" + } + ] + } + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "The file last write time." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-link-count": { + "type": "integer", + "format": "int32", + "description": "NFS only. The link count." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share": { + "put": { + "operationId": "Share_Create", + "description": "Creates a new share under the specified account. If the share with the same name already exists, the operation fails.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-share-quota", + "in": "header", + "description": "Specifies the maximum size of the share, in gigabytes.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-client-name": "quota" + }, + { + "name": "x-ms-access-tier", + "in": "header", + "description": "Specifies the access tier of the share.", + "required": false, + "type": "string", + "enum": [ + "TransactionOptimized", + "Hot", + "Cool", + "Premium" + ], + "x-ms-enum": { + "name": "ShareAccessTier", + "modelAsString": true, + "values": [ + { + "name": "TransactionOptimized", + "value": "TransactionOptimized", + "description": "TransactionOptimized" + }, + { + "name": "Hot", + "value": "Hot", + "description": "Hot" + }, + { + "name": "Cool", + "value": "Cool", + "description": "Cool" + }, + { + "name": "Premium", + "value": "Premium", + "description": "Premium" + } + ] + }, + "x-ms-client-name": "accessTier" + }, + { + "name": "x-ms-enabled-protocols", + "in": "header", + "description": "Protocols to enable on the share.", + "required": false, + "type": "string", + "x-ms-client-name": "enabledProtocols" + }, + { + "name": "x-ms-root-squash", + "in": "header", + "description": "Root squash to set on the share. Only valid for NFS shares.", + "required": false, + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false, + "values": [ + { + "name": "NoRootSquash", + "value": "NoRootSquash", + "description": "NoRootSquash" + }, + { + "name": "RootSquash", + "value": "RootSquash", + "description": "RootSquash" + }, + { + "name": "AllSquash", + "value": "AllSquash", + "description": "AllSquash" + } + ] + }, + "x-ms-client-name": "rootSquash" + }, + { + "name": "x-ms-enable-snapshot-virtual-directory-access", + "in": "header", + "description": "Optional. Used to enable snapshot virtual directory access.", + "required": false, + "type": "boolean", + "x-ms-client-name": "enableSnapshotVirtualDirectoryAccess" + }, + { + "name": "x-ms-share-paid-bursting-enabled", + "in": "header", + "description": "Optional. Boolean. Default if not specified is false. This property enables paid bursting.", + "required": false, + "type": "boolean", + "x-ms-client-name": "paidBurstingEnabled" + }, + { + "name": "x-ms-share-paid-bursting-max-iops", + "in": "header", + "description": "Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "paidBurstingMaxIops" + }, + { + "name": "x-ms-share-paid-bursting-max-bandwidth-mibps", + "in": "header", + "description": "Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "paidBurstingMaxBandwidthMibps" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-share-provisioned-iops", + "in": "header", + "description": "Optional. Specifies the provisioned IOPS of the share.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "shareProvisionedIops" + }, + { + "name": "x-ms-share-provisioned-bandwidth-mibps", + "in": "header", + "description": "Optional. Specifies the provisioned bandwidth of the share, in MiBps.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "shareProvisionedBandwidthMibps" + }, + { + "name": "x-ms-enable-smb-directory-lease", + "in": "header", + "description": "Optional. Used to enable SMB directory lease.", + "required": false, + "type": "boolean", + "x-ms-client-name": "enableSmbDirectoryLease" + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-share-included-burst-iops": { + "type": "integer", + "format": "int64", + "description": "The included burst IOPS." + }, + "x-ms-share-max-burst-credits-for-iops": { + "type": "integer", + "format": "int64", + "description": "The maximum burst credits for IOPS." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "type": "integer", + "format": "int64", + "description": "Optional. Specifies the provisioned bandwidth of the share, in MiBps." + }, + "x-ms-share-provisioned-iops": { + "type": "integer", + "format": "int64", + "description": "Optional. Specifies the provisioned IOPS of the share." + }, + "x-ms-share-quota": { + "type": "integer", + "format": "int32", + "description": "Specifies the maximum size of the share, in gigabytes." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&_overload=delete": { + "delete": { + "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.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-delete-snapshots", + "in": "header", + "description": "Specifies the option include to delete the base share and all of its snapshots.", + "required": false, + "type": "string", + "enum": [ + "include", + "include-leased" + ], + "x-ms-enum": { + "name": "DeleteSnapshotsOptionType", + "modelAsString": false, + "values": [ + { + "name": "include", + "value": "include", + "description": "include" + }, + { + "name": "include-leased", + "value": "include-leased", + "description": "include-leased" + } + ] + }, + "x-ms-client-name": "deleteSnapshots" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-share-snapshot-usage-bytes": { + "type": "integer", + "format": "int64", + "description": "The approximate size of the data stored on the share snapshot." + }, + "x-ms-file-share-usage-bytes": { + "type": "integer", + "format": "int64", + "description": "The approximate size of the data stored on the share." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&_overload=getProperties": { + "get": { + "operationId": "Share_GetProperties", + "description": "Returns all user-defined metadata and system properties for the specified share or share snapshot.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-access-tier": { + "type": "string", + "description": "The access tier of the share." + }, + "x-ms-access-tier-change-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The access tier change time." + }, + "x-ms-access-tier-transition-state": { + "type": "string", + "description": "The access tier transition state." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-enable-smb-directory-lease": { + "type": "boolean", + "description": "Whether SMB directory lease is enabled." + }, + "x-ms-enable-snapshot-virtual-directory-access": { + "type": "boolean", + "description": "Whether snapshot virtual directory access is enabled." + }, + "x-ms-enabled-protocols": { + "type": "string", + "description": "The enabled protocols for the share." + }, + "x-ms-lease-duration": { + "type": "string", + "description": "The lease duration." + }, + "x-ms-lease-state": { + "type": "string", + "description": "The lease state." + }, + "x-ms-lease-status": { + "type": "string", + "description": "The lease status." + }, + "x-ms-meta": { + "type": "string", + "description": "Optional. User-defined metadata for the resource." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-root-squash": { + "type": "string", + "description": "The root squash mode for the share." + }, + "x-ms-share-included-burst-iops": { + "type": "integer", + "format": "int64", + "description": "The included burst IOPS." + }, + "x-ms-share-max-burst-credits-for-iops": { + "type": "integer", + "format": "int64", + "description": "The maximum burst credits for IOPS." + }, + "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The next allowed provisioned bandwidth downgrade time." + }, + "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The next allowed provisioned IOPS downgrade time." + }, + "x-ms-share-next-allowed-quota-downgrade-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The next allowed quota downgrade time." + }, + "x-ms-share-paid-bursting-enabled": { + "type": "boolean", + "description": "Whether paid bursting is enabled." + }, + "x-ms-share-paid-bursting-max-bandwidth-mibps": { + "type": "integer", + "format": "int64", + "description": "The maximum bandwidth for paid bursting." + }, + "x-ms-share-paid-bursting-max-iops": { + "type": "integer", + "format": "int64", + "description": "The maximum IOPS for paid bursting." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "type": "integer", + "format": "int64", + "description": "The share provisioned bandwidth in mebibytes per second." + }, + "x-ms-share-provisioned-egress-mbps": { + "type": "integer", + "format": "int64", + "description": "The provisioned egress for the share." + }, + "x-ms-share-provisioned-ingress-mbps": { + "type": "integer", + "format": "int64", + "description": "The provisioned ingress for the share." + }, + "x-ms-share-provisioned-iops": { + "type": "integer", + "format": "int64", + "description": "The provisioned IOPS for the share." + }, + "x-ms-share-quota": { + "type": "integer", + "format": "int32", + "description": "Specifies the maximum size of the share, in gigabytes." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=acl": { + "get": { + "operationId": "Share_GetAccessPolicy", + "description": "Returns information about stored access policies specified on the share that may be used with Shared Access Signatures.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=acl&_overload=setAccessPolicy": { + "put": { + "operationId": "Share_SetAccessPolicy", + "description": "Sets stored access policies for the share that may be used with Shared Access Signatures.", + "produces": [ + "application/xml" + ], + "consumes": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "shareAcl", + "in": "body", + "description": "The ACL for the share.", + "required": false, + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=filepermission": { + "put": { + "operationId": "Share_CreatePermission", + "description": "Create a permission (a security descriptor). This is used to support file level ACLs for SMB shares.", + "produces": [ + "application/xml" + ], + "consumes": [ + "application/json" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "permission", + "in": "body", + "description": "A permission (a security descriptor) at the share level.", + "required": true, + "schema": { + "$ref": "#/definitions/SharePermission" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-permission-key": { + "type": "string", + "description": "Key of the permission set for the directory/file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=filepermission&_overload=getPermission": { + "get": { + "operationId": "Share_GetPermission", + "description": "Returns the permission (security descriptor) for a given permission key. This is used to support file level ACLs for SMB shares.", + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-file-permission-key", + "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": true, + "type": "string", + "x-ms-client-name": "filePermissionKey" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-permission-format", + "in": "header", + "description": "Optional. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary.", + "required": false, + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false, + "values": [ + { + "name": "Sddl", + "value": "Sddl", + "description": "Sddl" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Binary" + } + ] + }, + "x-ms-client-name": "filePermissionFormat" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SharePermission" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=lease": { + "put": { + "operationId": "Share_AcquireLease", + "description": "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-duration", + "in": "header", + "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.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-client-name": "leaseDuration" + }, + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "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.", + "required": false, + "type": "string", + "x-ms-client-name": "proposedLeaseId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Describes what lease action to take.", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "action" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-lease-id": { + "type": "string", + "description": "If specified, the lease ID must match the lease ID of the file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=lease&_overload=breakLease": { + "put": { + "operationId": "Share_BreakLease", + "description": "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-break-period", + "in": "header", + "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.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-client-name": "breakPeriod" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Describes what lease action to take.", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "action" + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-lease-id": { + "type": "string", + "description": "If specified, the lease ID must match the lease ID of the file." + }, + "x-ms-lease-time": { + "type": "integer", + "format": "int32", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=lease&_overload=changeLease": { + "put": { + "operationId": "Share_ChangeLease", + "description": "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Specifies the current lease ID on the resource.", + "required": true, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "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.", + "required": false, + "type": "string", + "x-ms-client-name": "proposedLeaseId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Describes what lease action to take.", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "action" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-lease-id": { + "type": "string", + "description": "If specified, the lease ID must match the lease ID of the file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=lease&_overload=releaseLease": { + "put": { + "operationId": "Share_ReleaseLease", + "description": "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Specifies the current lease ID on the resource.", + "required": true, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Describes what lease action to take.", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "action" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=lease&_overload=renewLease": { + "put": { + "operationId": "Share_RenewLease", + "description": "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Specifies the current lease ID on the resource.", + "required": true, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Describes what lease action to take.", + "required": true, + "type": "string", + "enum": [ + "renew" + ], + "x-ms-enum": { + "modelAsString": false + }, + "x-ms-client-name": "action" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-lease-id": { + "type": "string", + "description": "If specified, the lease ID must match the lease ID of the file." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=metadata": { + "put": { + "operationId": "Share_SetMetadata", + "description": "Sets one or more user-defined name-value pairs for the specified share.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=properties": { + "put": { + "operationId": "Share_SetProperties", + "description": "Sets properties for the specified share.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-share-quota", + "in": "header", + "description": "Specifies the maximum size of the share, in gigabytes.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-client-name": "quota" + }, + { + "name": "x-ms-access-tier", + "in": "header", + "description": "Specifies the access tier of the share.", + "required": false, + "type": "string", + "enum": [ + "TransactionOptimized", + "Hot", + "Cool", + "Premium" + ], + "x-ms-enum": { + "name": "ShareAccessTier", + "modelAsString": true, + "values": [ + { + "name": "TransactionOptimized", + "value": "TransactionOptimized", + "description": "TransactionOptimized" + }, + { + "name": "Hot", + "value": "Hot", + "description": "Hot" + }, + { + "name": "Cool", + "value": "Cool", + "description": "Cool" + }, + { + "name": "Premium", + "value": "Premium", + "description": "Premium" + } + ] + }, + "x-ms-client-name": "accessTier" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-root-squash", + "in": "header", + "description": "Root squash to set on the share. Only valid for NFS shares.", + "required": false, + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false, + "values": [ + { + "name": "NoRootSquash", + "value": "NoRootSquash", + "description": "NoRootSquash" + }, + { + "name": "RootSquash", + "value": "RootSquash", + "description": "RootSquash" + }, + { + "name": "AllSquash", + "value": "AllSquash", + "description": "AllSquash" + } + ] + }, + "x-ms-client-name": "rootSquash" + }, + { + "name": "x-ms-enable-snapshot-virtual-directory-access", + "in": "header", + "description": "Optional. Used to enable snapshot virtual directory access.", + "required": false, + "type": "boolean", + "x-ms-client-name": "enableSnapshotVirtualDirectoryAccess" + }, + { + "name": "x-ms-share-paid-bursting-enabled", + "in": "header", + "description": "Optional. Boolean. Default if not specified is false. This property enables paid bursting.", + "required": false, + "type": "boolean", + "x-ms-client-name": "paidBurstingEnabled" + }, + { + "name": "x-ms-share-paid-bursting-max-iops", + "in": "header", + "description": "Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "paidBurstingMaxIops" + }, + { + "name": "x-ms-share-paid-bursting-max-bandwidth-mibps", + "in": "header", + "description": "Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "paidBurstingMaxBandwidthMibps" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-share-provisioned-iops", + "in": "header", + "description": "Optional. Specifies the provisioned IOPS of the share.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "shareProvisionedIops" + }, + { + "name": "x-ms-share-provisioned-bandwidth-mibps", + "in": "header", + "description": "Optional. Specifies the provisioned bandwidth of the share, in MiBps.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "shareProvisionedBandwidthMibps" + }, + { + "name": "x-ms-enable-smb-directory-lease", + "in": "header", + "description": "Optional. Used to enable SMB directory lease.", + "required": false, + "type": "boolean", + "x-ms-client-name": "enableSmbDirectoryLease" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-share-included-burst-iops": { + "type": "integer", + "format": "int64", + "description": "The included burst IOPS." + }, + "x-ms-share-max-burst-credits-for-iops": { + "type": "integer", + "format": "int64", + "description": "The maximum burst credits for IOPS." + }, + "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The next allowed provisioned bandwidth downgrade time." + }, + "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The next allowed provisioned IOPS downgrade time." + }, + "x-ms-share-next-allowed-quota-downgrade-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The next allowed quota downgrade time." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "type": "integer", + "format": "int64", + "description": "The share provisioned bandwidth in mebibytes per second." + }, + "x-ms-share-provisioned-iops": { + "type": "integer", + "format": "int64", + "description": "The share provisioned IOPS." + }, + "x-ms-share-quota": { + "type": "integer", + "format": "int32", + "description": "Specifies the maximum size of the share, in gigabytes." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=snapshot": { + "put": { + "operationId": "Share_CreateSnapshot", + "description": "Creates a read-only snapshot of a share.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-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." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=stats": { + "get": { + "operationId": "Share_GetStatistics", + "description": "Retrieves statistics related to the share.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ShareStats" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=share&comp=undelete": { + "put": { + "operationId": "Share_Restore", + "description": "Restores a previously deleted share.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-deleted-share-name", + "in": "header", + "description": "Specifies the name of the previously-deleted share.", + "required": false, + "type": "string", + "x-ms-client-name": "deletedShareName" + }, + { + "name": "x-ms-deleted-share-version", + "in": "header", + "description": "Specifies the version of the previously-deleted share.", + "required": false, + "type": "string", + "x-ms-client-name": "deletedShareVersion" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-share-included-burst-iops": { + "type": "integer", + "format": "int64", + "description": "The included burst IOPS." + }, + "x-ms-share-max-burst-credits-for-iops": { + "type": "integer", + "format": "int64", + "description": "The maximum burst credits for IOPS." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "type": "integer", + "format": "int64", + "description": "The share provisioned bandwidth in mebibytes per second." + }, + "x-ms-share-provisioned-iops": { + "type": "integer", + "format": "int64", + "description": "The share provisioned IOPS." + }, + "x-ms-share-quota": { + "type": "integer", + "format": "int32", + "description": "Specifies the maximum size of the share, in gigabytes." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=symboliclink": { + "put": { + "operationId": "File_CreateSymbolicLink", + "description": "Creates a symbolic link to a target file. NFS only.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-file-creation-time", + "in": "header", + "description": "Creation time for the file.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileCreationTime" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "Last write time for the file.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileLastWriteTime" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-owner", + "in": "header", + "description": "Optional, NFS only. The owner of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "owner" + }, + { + "name": "x-ms-group", + "in": "header", + "description": "Optional, NFS only. The owning group of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "group" + }, + { + "name": "x-ms-link-text", + "in": "header", + "description": "NFS only. The path to the original file, the symbolic link is pointing to.", + "required": true, + "type": "string", + "x-ms-client-name": "linkText" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-file-change-time": { + "type": "string", + "format": "date-time", + "description": "The file change time." + }, + "x-ms-file-creation-time": { + "type": "string", + "format": "date-time", + "description": "The file creation time." + }, + "x-ms-file-file-type": { + "type": "string", + "description": "NFS only. The file type.", + "enum": [ + "Regular", + "Directory", + "SymLink" + ], + "x-ms-enum": { + "name": "NfsFileType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular" + }, + { + "name": "Directory", + "value": "Directory", + "description": "Directory" + }, + { + "name": "SymLink", + "value": "SymLink", + "description": "SymLink" + } + ] + } + }, + "x-ms-file-id": { + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-last-write-time": { + "type": "string", + "format": "date-time", + "description": "The file last write time." + }, + "x-ms-file-parent-id": { + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-group": { + "type": "string", + "description": "NFS only. The owning group." + }, + "x-ms-mode": { + "type": "string", + "description": "NFS only. The file mode." + }, + "x-ms-owner": { + "type": "string", + "description": "NFS only. The owner." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "?restype=symboliclink&_overload=getSymbolicLink": { + "get": { + "operationId": "File_GetSymbolicLink", + "description": "Returns the target of a symbolic link. NFS only.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that specifies a share snapshot.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-link-text": { + "type": "string", + "description": "NFS only. The path to the original file, the symbolic link is pointing to." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "/?_overload=startCopy": { + "put": { + "operationId": "File_StartCopy", + "description": "Copies a blob or file to a destination file within the storage account.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-copy-source", + "in": "header", + "description": "Specifies the URL of the source file or blob, up to 2 KB in length.", + "required": true, + "type": "string", + "x-ms-client-name": "copySource" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-meta", + "in": "header", + "description": "Optional. User-defined metadata for the resource.", + "required": false, + "type": "string", + "x-ms-client-name": "metadata" + }, + { + "name": "x-ms-file-permission", + "in": "header", + "description": "If specified the permission shall be set for the file.", + "required": false, + "type": "string", + "x-ms-client-name": "filePermission" + }, + { + "name": "x-ms-file-permission-format", + "in": "header", + "description": "Optional. Used to set permission format.", + "required": false, + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false, + "values": [ + { + "name": "Sddl", + "value": "Sddl", + "description": "Sddl" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Binary" + } + ] + }, + "x-ms-client-name": "filePermissionFormat" + }, + { + "name": "x-ms-file-permission-key", + "in": "header", + "description": "Key of the permission to be set.", + "required": false, + "type": "string", + "x-ms-client-name": "filePermissionKey" + }, + { + "name": "x-ms-file-permission-copy-mode", + "in": "header", + "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.", + "required": false, + "type": "string", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "PermissionCopyModeType", + "modelAsString": false, + "values": [ + { + "name": "source", + "value": "source", + "description": "source" + }, + { + "name": "override", + "value": "override", + "description": "override" + } + ] + }, + "x-ms-client-name": "filePermissionCopyMode" + }, + { + "name": "x-ms-file-copy-ignore-readonly", + "in": "header", + "description": "A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected or overridden.", + "required": false, + "type": "boolean", + "x-ms-client-name": "ignoreReadOnly" + }, + { + "name": "x-ms-file-attributes", + "in": "header", + "description": "If specified, the provided file attributes shall be set.", + "required": false, + "type": "string", + "x-ms-client-name": "fileAttributes" + }, + { + "name": "x-ms-file-creation-time", + "in": "header", + "description": "Creation time for the file.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileCreationTime" + }, + { + "name": "x-ms-file-last-write-time", + "in": "header", + "description": "Last write time for the file.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileLastWriteTime" + }, + { + "name": "x-ms-file-change-time", + "in": "header", + "description": "Change time for the file.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-client-name": "fileChangeTime" + }, + { + "name": "x-ms-file-copy-set-archive", + "in": "header", + "description": "Optional. Sets the archive attribute on the destination file.", + "required": false, + "type": "boolean", + "x-ms-client-name": "setArchiveAttribute" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the lease ID must match the lease ID of the file.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the target file/directory path.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowTrailingDot" + }, + { + "name": "x-ms-source-allow-trailing-dot", + "in": "header", + "description": "If true, the trailing dot will not be trimmed from the source URI.", + "required": false, + "type": "boolean", + "x-ms-client-name": "allowSourceTrailingDot" + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "x-ms-owner", + "in": "header", + "description": "Optional, NFS only. The owner of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "owner" + }, + { + "name": "x-ms-group", + "in": "header", + "description": "Optional, NFS only. The owning group of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "group" + }, + { + "name": "x-ms-mode", + "in": "header", + "description": "Optional, NFS only. The file mode of the file or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "fileMode" + }, + { + "name": "x-ms-file-mode-copy-mode", + "in": "header", + "description": "Specifies mode copy option for the file.", + "required": false, + "type": "string", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "ModeCopyMode", + "modelAsString": false, + "values": [ + { + "name": "source", + "value": "source", + "description": "source" + }, + { + "name": "override", + "value": "override", + "description": "override" + } + ] + }, + "x-ms-client-name": "fileModeCopyMode" + }, + { + "name": "x-ms-file-owner-copy-mode", + "in": "header", + "description": "Specifies owner copy option for the file.", + "required": false, + "type": "string", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "OwnerCopyMode", + "modelAsString": false, + "values": [ + { + "name": "source", + "value": "source", + "description": "source" + }, + { + "name": "override", + "value": "override", + "description": "override" + } + ] + }, + "x-ms-client-name": "fileOwnerCopyMode" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that represents the version of the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-copy-id": { + "type": "string", + "description": "String identifier for this copy operation." + }, + "x-ms-copy-status": { + "type": "string", + "description": "State of the copy operation identified by x-ms-copy-id.", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": false, + "values": [ + { + "name": "Pending", + "value": "pending", + "description": "The copy operation is pending." + }, + { + "name": "Success", + "value": "success", + "description": "The copy operation succeeded." + }, + { + "name": "Aborted", + "value": "aborted", + "description": "The copy operation was aborted." + }, + { + "name": "Failed", + "value": "failed", + "description": "The copy operation failed." + } + ] + } + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "/?comp=list": { + "get": { + "operationId": "Service_ListSharesSegment", + "description": "The List Shares Segment operation returns a list of the shares and share snapshots under the specified account.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "prefix", + "in": "query", + "description": "Filters the results to return only items whose name begins with the specified prefix.", + "required": false, + "type": "string" + }, + { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next listing operation.", + "required": false, + "type": "string" + }, + { + "name": "maxresults", + "in": "query", + "description": "Specifies the maximum number of items to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "snapshots", + "metadata", + "deleted" + ], + "x-ms-enum": { + "name": "ListSharesIncludeType", + "modelAsString": false, + "values": [ + { + "name": "snapshots", + "value": "snapshots", + "description": "snapshots" + }, + { + "name": "metadata", + "value": "metadata", + "description": "metadata" + }, + { + "name": "deleted", + "value": "deleted", + "description": "deleted" + } + ] + } + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListSharesResponse" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "/?restype=service&comp=properties": { + "put": { + "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.", + "produces": [ + "application/xml" + ], + "consumes": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + }, + { + "name": "storageServiceProperties", + "in": "body", + "description": "Storage service properties", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "/?restype=service&comp=properties&_overload=getProperties": { + "get": { + "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.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "x-ms-file-request-intent", + "in": "header", + "description": "Valid values are 'backup'.", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + }, + "x-ms-client-name": "fileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "/?restype=service&comp=userdelegationkey": { + "post": { + "operationId": "Service_GetUserDelegationKey", + "description": "Retrieves a user delegation key for the File service. This can be used to generate a user delegation SAS.", + "produces": [ + "application/xml" + ], + "consumes": [ + "application/xml" + ], + "parameters": [ + { + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "x-ms-client-name": "version" + }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "keyInfo", + "in": "body", + "description": "Key information", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/UserDelegationKey" + }, + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A GMT date/time value generated by the service that indicates the time the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "x-ms-copy-source-error-code": { + "type": "string", + "description": "The error code for the copy source." + }, + "x-ms-copy-source-status-code": { + "type": "integer", + "format": "int32", + "description": "The status code for the copy source." + }, + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + } + }, + "definitions": { + "AccessPolicy": { + "type": "object", + "description": "An Access policy.", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The date-time the policy is active.", + "xml": { + "name": "Start" + } + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "The date-time the policy expires.", + "xml": { + "name": "Expiry" + } + }, + "permission": { + "type": "string", + "description": "The permissions for the ACL policy.", + "xml": { + "name": "Permission" + } + } + } + }, + "AccessRight": { + "type": "string", + "description": "Access rights of the access policy.", + "enum": [ + "Read", + "Write", + "Delete" + ], + "x-ms-enum": { + "name": "AccessRight", + "modelAsString": false, + "values": [ + { + "name": "Read", + "value": "Read", + "description": "Read" + }, + { + "name": "Write", + "value": "Write", + "description": "Write" + }, + { + "name": "Delete", + "value": "Delete", + "description": "Delete" + } + ] + } + }, + "Azure.Core.eTag": { + "type": "string", + "description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.\nIt lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.\n\nIt is a string of ASCII characters placed between double quotes, like \"675af34563dc-tr34\".", + "xml": { + "name": "eTag" + } + }, + "ClearRange": { + "type": "object", + "description": "A clear range.", + "properties": { + "start": { + "type": "integer", + "format": "int64", + "description": "Start of the range.", + "xml": { + "name": "Start" + } + }, + "end": { + "type": "integer", + "format": "int64", + "description": "End of the range.", + "xml": { + "name": "End" + } + } + }, + "required": [ + "start", + "end" + ] + }, + "CopyStatus": { + "type": "string", + "description": "The copy status.", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": false, + "values": [ + { + "name": "Pending", + "value": "pending", + "description": "The copy operation is pending." + }, + { + "name": "Success", + "value": "success", + "description": "The copy operation succeeded." + }, + { + "name": "Aborted", + "value": "aborted", + "description": "The copy operation was aborted." + }, + { + "name": "Failed", + "value": "failed", + "description": "The copy operation failed." + } + ] + } + }, + "CorsRule": { + "type": "object", + "description": "CORS is an HTTP feature that enables a web application running under one domain\nto access resources in another domain. Web browsers implement a security\nrestriction known as same-origin policy that prevents a web page from calling\nAPIs in a different domain; CORS provides a secure way to allow one domain (the\norigin domain) to call APIs in another domain.", + "properties": { + "allowedOrigins": { + "type": "string", + "description": "The origin domains that are permitted to make a request against the storage\nservice via CORS. The origin domain is the domain from which the request\noriginates. Note that the origin must be an exact case-sensitive match with the\norigin that the user age sends to the service. You can also use the wildcard\ncharacter '*' to allow all origin domains to make requests via CORS.", + "xml": { + "name": "AllowedOrigins" + } + }, + "allowedMethods": { + "type": "string", + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS\nrequest. (comma separated)", + "xml": { + "name": "AllowedMethods" + } + }, + "allowedHeaders": { + "type": "string", + "description": "The request headers that the origin domain may specify on the CORS request.", + "xml": { + "name": "AllowedHeaders" + } + }, + "exposedHeaders": { + "type": "string", + "description": "The response headers that may be sent in the response to the CORS request and\nexposed by the browser to the request issuer.", + "xml": { + "name": "ExposedHeaders" + } + }, + "maxAgeInSeconds": { + "type": "integer", + "format": "int32", + "description": "The maximum amount time that a browser should cache the preflight OPTIONS\nrequest.", + "xml": { + "name": "MaxAgeInSeconds" + } + } + }, + "required": [ + "allowedOrigins", + "allowedMethods", + "allowedHeaders", + "exposedHeaders", + "maxAgeInSeconds" + ] + }, + "DeleteSnapshotsOptionType": { + "type": "string", + "description": "The delete snapshots option type.", + "enum": [ + "include", + "include-leased" + ], + "x-ms-enum": { + "name": "DeleteSnapshotsOptionType", + "modelAsString": false, + "values": [ + { + "name": "include", + "value": "include", + "description": "include" + }, + { + "name": "include-leased", + "value": "include-leased", + "description": "include-leased" + } + ] + } + }, + "DirectoryItem": { + "type": "object", + "description": "A listed directory item.", + "properties": { + "name": { + "$ref": "#/definitions/StringEncoded", + "description": "The directory name.", + "xml": { + "name": "Name" + } + }, + "fileId": { + "type": "string", + "description": "The file ID.", + "xml": { + "name": "FileId" + } + }, + "properties": { + "$ref": "#/definitions/FileProperty", + "description": "File properties.", + "xml": { + "name": "Properties" + } + }, + "attributes": { + "type": "string", + "description": "The file attributes.", + "xml": { + "name": "Attributes" + } + }, + "permissionKey": { + "type": "string", + "description": "The permission key.", + "xml": { + "name": "PermissionKey" + } + } + }, + "required": [ + "name" + ], + "xml": { + "name": "Directory" + } + }, + "Error": { + "type": "object", + "description": "The error response.\n\nThis defines the wire format only. Language SDKs wrap this in idiomatic error types.", + "properties": { + "code": { + "$ref": "#/definitions/StorageErrorCode", + "description": "The error code.", + "xml": { + "name": "Code" + } + }, + "message": { + "type": "string", + "description": "The error message.", + "xml": { + "name": "Message" + } + }, + "copySourceStatusCode": { + "type": "integer", + "format": "int32", + "description": "Copy source status code", + "xml": { + "name": "CopySourceStatusCode" + } + }, + "copySourceErrorCode": { + "type": "string", + "description": "Copy source error code", + "xml": { + "name": "CopySourceErrorCode" + } + }, + "copySourceErrorMessage": { + "type": "string", + "description": "Copy source error message", + "xml": { + "name": "CopySourceErrorMessage" + } + } + } + }, + "FileItem": { + "type": "object", + "description": "A listed file item.", + "properties": { + "name": { + "$ref": "#/definitions/StringEncoded", + "description": "The file name.", + "xml": { + "name": "Name" + } + }, + "fileId": { + "type": "string", + "description": "The file ID.", + "xml": { + "name": "FileId" + } + }, + "properties": { + "$ref": "#/definitions/FileProperty", + "description": "File properties.", + "xml": { + "name": "Properties" + } + }, + "attributes": { + "type": "string", + "description": "The file attributes.", + "xml": { + "name": "Attributes" + } + }, + "permissionKey": { + "type": "string", + "description": "The permission key.", + "xml": { + "name": "PermissionKey" + } + } + }, + "required": [ + "name", + "properties" + ], + "xml": { + "name": "File" + } + }, + "FileLastWrittenMode": { + "type": "string", + "description": "The file last written mode.", + "enum": [ + "Now", + "Preserve" + ], + "x-ms-enum": { + "name": "FileLastWrittenMode", + "modelAsString": false, + "values": [ + { + "name": "Now", + "value": "Now", + "description": "Now" + }, + { + "name": "Preserve", + "value": "Preserve", + "description": "Preserve" + } + ] + } + }, + "FilePermissionFormat": { + "type": "string", + "description": "The file permission format.", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false, + "values": [ + { + "name": "Sddl", + "value": "Sddl", + "description": "Sddl" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Binary" + } + ] + } + }, + "FileProperty": { + "type": "object", + "description": "File properties.", + "properties": { + "contentLength": { + "type": "integer", + "format": "int64", + "description": "Content length of the file. This value may not be up-to-date since an SMB\nclient may have modified the file locally. The value of Content-Length may not\nreflect that fact until the handle is closed or the op-lock is broken. To\nretrieve current property values, call Get File Properties.", + "xml": { + "name": "Content-Length" + } + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The creation time.", + "xml": { + "name": "CreationTime" + } + }, + "lastAccessTime": { + "type": "string", + "format": "date-time", + "description": "The last access time.", + "xml": { + "name": "LastAccessTime" + } + }, + "lastWriteTime": { + "type": "string", + "format": "date-time", + "description": "The last write time.", + "xml": { + "name": "LastWriteTime" + } + }, + "changeTime": { + "type": "string", + "format": "date-time", + "description": "The change time.", + "xml": { + "name": "ChangeTime" + } + }, + "lastModified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The last modified time.", + "xml": { + "name": "Last-Modified" + } + }, + "eTag": { + "$ref": "#/definitions/Azure.Core.eTag", + "description": "The ETag of the file.", + "xml": { + "name": "Etag" + } + } + }, + "required": [ + "contentLength" + ] + }, + "FilePropertySemantics": { + "type": "string", + "description": "The file property semantics.", + "enum": [ + "New", + "Restore" + ], + "x-ms-enum": { + "name": "FilePropertySemantics", + "modelAsString": true, + "values": [ + { + "name": "New", + "value": "New", + "description": "New" + }, + { + "name": "Restore", + "value": "Restore", + "description": "Restore" + } + ] + } + }, + "FileRange": { + "type": "object", + "description": "An Azure Storage file range.", + "properties": { + "start": { + "type": "integer", + "format": "int64", + "description": "Start of the range.", + "xml": { + "name": "Start" + } + }, + "end": { + "type": "integer", + "format": "int64", + "description": "End of the range.", + "xml": { + "name": "End" + } + } + }, + "required": [ + "start", + "end" + ], + "xml": { + "name": "Range" + } + }, + "FileRangeWriteFromUrlType": { + "type": "string", + "description": "Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range.", + "enum": [ + "update" + ], + "x-ms-enum": { + "name": "FileRangeWriteFromUrlType", + "modelAsString": false, + "values": [ + { + "name": "update", + "value": "update", + "description": "Writes the bytes specified by the source URL into the specified range." + } + ] + } + }, + "FileRangeWriteType": { + "type": "string", + "description": "Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. - Clear: Clears the specified range and releases the space used in storage for that range.", + "enum": [ + "update", + "clear" + ], + "x-ms-enum": { + "name": "FileRangeWriteType", + "modelAsString": false, + "values": [ + { + "name": "update", + "value": "update", + "description": "Writes the bytes specified by the request body into the specified range." + }, + { + "name": "clear", + "value": "clear", + "description": "Clears the specified range and releases the space used in storage for that range." + } + ] + } + }, + "FilesAndDirectoriesListSegment": { + "type": "object", + "description": "Abstract for entries that can be listed from Directory.", + "properties": { + "directoryItems": { + "type": "array", + "description": "The directory items.", + "items": { + "$ref": "#/definitions/DirectoryItem" + }, + "xml": { + "name": "Directory", + "wrapped": false + } + }, + "fileItems": { + "type": "array", + "description": "The file items.", + "items": { + "$ref": "#/definitions/FileItem" + }, + "xml": { + "name": "File", + "wrapped": false + } + } + }, + "required": [ + "directoryItems", + "fileItems" + ] + }, + "HandleItem": { + "type": "object", + "description": "A listed Azure Storage handle item.", + "properties": { + "handleId": { + "type": "string", + "description": "XSMB service handle ID", + "xml": { + "name": "HandleId" + } + }, + "path": { + "$ref": "#/definitions/StringEncoded", + "description": "The path.", + "xml": { + "name": "Path" + } + }, + "fileId": { + "type": "string", + "description": "FileId uniquely identifies the file or directory.", + "xml": { + "name": "FileId" + } + }, + "parentId": { + "type": "string", + "description": "ParentId uniquely identifies the parent directory of the object.", + "xml": { + "name": "ParentId" + } + }, + "sessionId": { + "type": "string", + "description": "SMB session ID in context of which the file handle was opened", + "xml": { + "name": "SessionId" + } + }, + "clientIp": { + "type": "string", + "description": "Client IP that opened the handle", + "xml": { + "name": "ClientIp" + } + }, + "clientName": { + "type": "string", + "description": "Name of the client machine where the share is being mounted", + "xml": { + "name": "ClientName" + } + }, + "openTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Time when the session that previously opened the handle has last been\nreconnected. (UTC)", + "xml": { + "name": "OpenTime" + } + }, + "lastReconnectTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Time handle was last connected to (UTC)", + "xml": { + "name": "LastReconnectTime" + } + }, + "accessRightList": { + "type": "array", + "description": "The access rights.", + "items": { + "$ref": "#/definitions/AccessRight" + }, + "xml": { + "name": "AccessRightList", + "wrapped": true + } + } + }, + "required": [ + "handleId", + "path", + "fileId", + "sessionId", + "clientIp", + "clientName", + "openTime" + ], + "xml": { + "name": "Handle" + } + }, + "KeyInfo": { + "type": "object", + "description": "Key information", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The date-time the key is active in ISO 8601 UTC time", + "xml": { + "name": "Start" + } + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "The date-time the key expires in ISO 8601 UTC time", + "xml": { + "name": "Expiry" + } + }, + "delegatedUserTid": { + "type": "string", + "description": "The delegated user tenant id in Azure AD", + "xml": { + "name": "DelegatedUserTid" + } + } + }, + "required": [ + "expiry" + ] + }, + "LeaseDurationType": { + "type": "string", + "description": "When a share is leased, specifies whether the lease is of infinite or fixed\nduration.", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false, + "values": [ + { + "name": "infinite", + "value": "infinite", + "description": "infinite" + }, + { + "name": "fixed", + "value": "fixed", + "description": "fixed" + } + ] + } + }, + "LeaseStateType": { + "type": "string", + "description": "Lease state of the share.", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false, + "values": [ + { + "name": "available", + "value": "available", + "description": "available" + }, + { + "name": "leased", + "value": "leased", + "description": "leased" + }, + { + "name": "expired", + "value": "expired", + "description": "expired" + }, + { + "name": "breaking", + "value": "breaking", + "description": "breaking" + }, + { + "name": "broken", + "value": "broken", + "description": "broken" + } + ] + } + }, + "LeaseStatusType": { + "type": "string", + "description": "The current lease status of the share.", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false, + "values": [ + { + "name": "locked", + "value": "locked", + "description": "locked" + }, + { + "name": "unlocked", + "value": "unlocked", + "description": "unlocked" + } + ] + } + }, + "ListFilesAndDirectoriesSegmentResponse": { + "type": "object", + "description": "An enumeration of directories and files.", + "properties": { + "serviceEndpoint": { + "type": "string", + "description": "The service endpoint.", + "xml": { + "name": "ServiceEndpoint", + "attribute": true + } + }, + "shareName": { + "type": "string", + "description": "The share name.", + "xml": { + "name": "ShareName", + "attribute": true + } + }, + "shareSnapshot": { + "type": "string", + "description": "The share snapshot.", + "xml": { + "name": "ShareSnapshot", + "attribute": true + } + }, + "encoded": { + "type": "boolean", + "description": "Whether the listing is encoded.", + "xml": { + "name": "Encoded", + "attribute": true + } + }, + "directoryPath": { + "type": "string", + "description": "The directory path.", + "xml": { + "name": "DirectoryPath", + "attribute": true + } + }, + "prefix": { + "$ref": "#/definitions/StringEncoded", + "description": "The prefix.", + "xml": { + "name": "Prefix" + } + }, + "marker": { + "type": "string", + "description": "The marker.", + "xml": { + "name": "Marker" + } + }, + "maxResults": { + "type": "integer", + "format": "int32", + "description": "The max results.", + "xml": { + "name": "MaxResults" + } + }, + "segment": { + "$ref": "#/definitions/FilesAndDirectoriesListSegment", + "description": "Abstract for entries that can be listed from Directory.", + "xml": { + "name": "Entries" + } + }, + "nextMarker": { + "type": "string", + "description": "The next marker.", + "xml": { + "name": "NextMarker" + } + }, + "directoryId": { + "type": "string", + "description": "The directory ID.", + "xml": { + "name": "DirectoryId" + } + } + }, + "required": [ + "serviceEndpoint", + "shareName", + "directoryPath", + "prefix", + "segment", + "nextMarker" + ], + "xml": { + "name": "EnumerationResults" + } + }, + "ListFilesIncludeType": { + "type": "string", + "description": "The type of file information to include in the listing.", + "enum": [ + "Timestamps", + "Etag", + "Attributes", + "PermissionKey" + ], + "x-ms-enum": { + "name": "ListFilesIncludeType", + "modelAsString": false, + "values": [ + { + "name": "Timestamps", + "value": "Timestamps", + "description": "Timestamps" + }, + { + "name": "Etag", + "value": "Etag", + "description": "Etag" + }, + { + "name": "Attributes", + "value": "Attributes", + "description": "Attributes" + }, + { + "name": "PermissionKey", + "value": "PermissionKey", + "description": "PermissionKey" + } + ] + } + }, + "ListHandlesResponse": { + "type": "object", + "description": "An enumeration of handles.", + "properties": { + "handleList": { + "type": "array", + "description": "The handle list.", + "items": { + "$ref": "#/definitions/HandleItem" + }, + "xml": { + "name": "Entries", + "wrapped": true + } + }, + "nextMarker": { + "type": "string", + "description": "The next marker.", + "xml": { + "name": "NextMarker" + } + } + }, + "required": [ + "nextMarker" + ], + "xml": { + "name": "EnumerationResults" + } + }, + "ListSharesIncludeType": { + "type": "string", + "description": "The type of share information to include in the listing.", + "enum": [ + "snapshots", + "metadata", + "deleted" + ], + "x-ms-enum": { + "name": "ListSharesIncludeType", + "modelAsString": false, + "values": [ + { + "name": "snapshots", + "value": "snapshots", + "description": "snapshots" + }, + { + "name": "metadata", + "value": "metadata", + "description": "metadata" + }, + { + "name": "deleted", + "value": "deleted", + "description": "deleted" + } + ] + } + }, + "ListSharesResponse": { + "type": "object", + "description": "An enumeration of shares.", + "properties": { + "serviceEndpoint": { + "type": "string", + "description": "The service endpoint.", + "xml": { + "name": "ServiceEndpoint", + "attribute": true + } + }, + "prefix": { + "type": "string", + "description": "The prefix.", + "xml": { + "name": "Prefix" + } + }, + "marker": { + "type": "string", + "description": "The marker.", + "xml": { + "name": "Marker" + } + }, + "maxResults": { + "type": "integer", + "format": "int32", + "description": "The max results.", + "xml": { + "name": "MaxResults" + } + }, + "shareItems": { + "type": "array", + "description": "The share items.", + "items": { + "$ref": "#/definitions/ShareItemInternal" + }, + "xml": { + "name": "Shares", + "wrapped": true + } + }, + "nextMarker": { + "type": "string", + "description": "The next marker.", + "xml": { + "name": "NextMarker" + } + } + }, + "required": [ + "serviceEndpoint", + "nextMarker" + ], + "xml": { + "name": "EnumerationResults" + } + }, + "Metrics": { + "type": "object", + "description": "Storage Analytics metrics for file service.", + "properties": { + "version": { + "type": "string", + "description": "The version of Storage Analytics to configure.", + "xml": { + "name": "Version" + } + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether metrics are enabled for the File service.", + "xml": { + "name": "Enabled" + } + }, + "includeApis": { + "type": "boolean", + "description": "Indicates whether metrics should generate summary statistics for called API\noperations.", + "xml": { + "name": "IncludeAPIs" + } + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "The retention policy.", + "xml": { + "name": "RetentionPolicy" + } + } + }, + "required": [ + "version", + "enabled" + ] + }, + "ModeCopyMode": { + "type": "string", + "description": "The mode copy mode.", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "ModeCopyMode", + "modelAsString": false, + "values": [ + { + "name": "source", + "value": "source", + "description": "source" + }, + { + "name": "override", + "value": "override", + "description": "override" + } + ] + } + }, + "NfsFileType": { + "type": "string", + "description": "The NFS file type.", + "enum": [ + "Regular", + "Directory", + "SymLink" + ], + "x-ms-enum": { + "name": "NfsFileType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular" + }, + { + "name": "Directory", + "value": "Directory", + "description": "Directory" + }, + { + "name": "SymLink", + "value": "SymLink", + "description": "SymLink" + } + ] + } + }, + "OwnerCopyMode": { + "type": "string", + "description": "The owner copy mode.", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "OwnerCopyMode", + "modelAsString": false, + "values": [ + { + "name": "source", + "value": "source", + "description": "source" + }, + { + "name": "override", + "value": "override", + "description": "override" + } + ] + } + }, + "PermissionCopyModeType": { + "type": "string", + "description": "The permission copy mode type.", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "PermissionCopyModeType", + "modelAsString": false, + "values": [ + { + "name": "source", + "value": "source", + "description": "source" + }, + { + "name": "override", + "value": "override", + "description": "override" + } + ] + } + }, + "RetentionPolicy": { + "type": "object", + "description": "The retention policy.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether a retention policy is enabled for the File service. If false,\nmetrics data is retained, and the user is responsible for deleting it.", + "xml": { + "name": "Enabled" + } + }, + "days": { + "type": "integer", + "format": "int32", + "description": "Indicates the number of days that metrics data should be retained. All data\nolder than this value will be deleted. Metrics data is deleted on a best-effort\nbasis after the retention period expires.", + "minimum": 1, + "maximum": 365, + "xml": { + "name": "Days" + } + } + }, + "required": [ + "enabled" + ] + }, + "ShareAccessTier": { + "type": "string", + "description": "The access tier of the share.", + "enum": [ + "TransactionOptimized", + "Hot", + "Cool", + "Premium" + ], + "x-ms-enum": { + "name": "ShareAccessTier", + "modelAsString": true, + "values": [ + { + "name": "TransactionOptimized", + "value": "TransactionOptimized", + "description": "TransactionOptimized" + }, + { + "name": "Hot", + "value": "Hot", + "description": "Hot" + }, + { + "name": "Cool", + "value": "Cool", + "description": "Cool" + }, + { + "name": "Premium", + "value": "Premium", + "description": "Premium" + } + ] + } + }, + "ShareFileRangeList": { + "type": "object", + "description": "The list of file ranges", + "properties": { + "ranges": { + "type": "array", + "description": "The file ranges.", + "items": { + "$ref": "#/definitions/FileRange" + }, + "xml": { + "name": "Range", + "wrapped": false + } + }, + "clearRanges": { + "type": "array", + "description": "The clear ranges.", + "items": { + "$ref": "#/definitions/ClearRange" + }, + "xml": { + "name": "ClearRange", + "wrapped": false + } + } + }, + "xml": { + "name": "Ranges" + } + }, + "ShareFileRangeListSegment": { + "type": "object", + "description": "The paginated list of file ranges", + "properties": { + "ranges": { + "type": "array", + "description": "The file ranges.", + "items": { + "$ref": "#/definitions/FileRange" + }, + "xml": { + "name": "Range", + "wrapped": false + } + }, + "clearRanges": { + "type": "array", + "description": "The clear ranges.", + "items": { + "$ref": "#/definitions/ClearRange" + }, + "xml": { + "name": "ClearRange", + "wrapped": false + } + }, + "nextMarker": { + "type": "string", + "description": "The next marker.", + "xml": { + "name": "NextMarker" + } + } + }, + "xml": { + "name": "Ranges" + } + }, + "ShareItemInternal": { + "type": "object", + "description": "A listed Azure Storage share item.", + "properties": { + "name": { + "type": "string", + "description": "The share name.", + "xml": { + "name": "Name" + } + }, + "snapshot": { + "type": "string", + "description": "The share snapshot.", + "xml": { + "name": "Snapshot" + } + }, + "deleted": { + "type": "boolean", + "description": "Whether the share is deleted.", + "xml": { + "name": "Deleted" + } + }, + "version": { + "type": "string", + "description": "The share version.", + "xml": { + "name": "Version" + } + }, + "properties": { + "$ref": "#/definitions/SharePropertiesInternal", + "description": "Properties of a share.", + "xml": { + "name": "Properties" + } + }, + "metadata": { + "type": "object", + "description": "Dictionary of ", + "additionalProperties": { + "type": "string" + }, + "xml": { + "name": "Metadata" + } + } + }, + "required": [ + "name", + "properties" + ], + "xml": { + "name": "Share" + } + }, + "ShareNfsSettings": { + "type": "object", + "description": "Settings for SMB protocol.", + "properties": { + "encryptionInTransit": { + "$ref": "#/definitions/ShareNfsSettingsEncryptionInTransit", + "description": "Enable or disable encryption in transit.", + "xml": { + "name": "EncryptionInTransit" + } + } + }, + "xml": { + "name": "NFS" + } + }, + "ShareNfsSettingsEncryptionInTransit": { + "type": "object", + "description": "Enable or disable encryption in transit.", + "properties": { + "required": { + "type": "boolean", + "description": "If encryption in transit is required", + "xml": { + "name": "Required" + } + } + } + }, + "SharePermission": { + "type": "object", + "description": "A permission (a security descriptor) at the share level.", + "properties": { + "permission": { + "type": "string", + "description": "The permission in the Security Descriptor Definition Language (SDDL)." + }, + "format": { + "$ref": "#/definitions/FilePermissionFormat", + "description": "The permission format." + } + }, + "required": [ + "permission" + ] + }, + "SharePropertiesInternal": { + "type": "object", + "description": "Properties of a share.", + "properties": { + "lastModified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The last modified time.", + "xml": { + "name": "Last-Modified" + } + }, + "eTag": { + "$ref": "#/definitions/Azure.Core.eTag", + "description": "The ETag of the share.", + "xml": { + "name": "Etag" + } + }, + "quota": { + "type": "integer", + "format": "int32", + "description": "The share quota.", + "xml": { + "name": "Quota" + } + }, + "provisionedIops": { + "type": "integer", + "format": "int32", + "description": "The provisioned IOPS.", + "xml": { + "name": "ProvisionedIops" + } + }, + "provisionedIngressMBps": { + "type": "integer", + "format": "int32", + "description": "The provisioned ingress in MBps.", + "xml": { + "name": "ProvisionedIngressMBps" + } + }, + "provisionedEgressMBps": { + "type": "integer", + "format": "int32", + "description": "The provisioned egress in MBps.", + "xml": { + "name": "ProvisionedEgressMBps" + } + }, + "provisionedBandwidthMiBps": { + "type": "integer", + "format": "int32", + "description": "The provisioned bandwidth in MiBps.", + "xml": { + "name": "ProvisionedBandwidthMiBps" + } + }, + "nextAllowedQuotaDowngradeTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The next allowed quota downgrade time.", + "xml": { + "name": "NextAllowedQuotaDowngradeTime" + } + }, + "deletedTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The deleted time.", + "xml": { + "name": "DeletedTime" + } + }, + "remainingRetentionDays": { + "type": "integer", + "format": "int32", + "description": "The remaining retention days.", + "xml": { + "name": "RemainingRetentionDays" + } + }, + "accessTier": { + "type": "string", + "description": "The access tier.", + "xml": { + "name": "AccessTier" + } + }, + "accessTierChangeTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The access tier change time.", + "xml": { + "name": "AccessTierChangeTime" + } + }, + "accessTierTransitionState": { + "type": "string", + "description": "The access tier transition state.", + "xml": { + "name": "AccessTierTransitionState" + } + }, + "leaseStatus": { + "$ref": "#/definitions/LeaseStatusType", + "description": "The current lease status of the share.", + "xml": { + "name": "LeaseStatus" + } + }, + "leaseState": { + "$ref": "#/definitions/LeaseStateType", + "description": "Lease state of the share.", + "xml": { + "name": "LeaseState" + } + }, + "leaseDuration": { + "$ref": "#/definitions/LeaseDurationType", + "description": "When a share is leased, specifies whether the lease is of infinite or fixed\nduration.", + "xml": { + "name": "LeaseDuration" + } + }, + "enabledProtocols": { + "type": "string", + "description": "The enabled protocols.", + "xml": { + "name": "EnabledProtocols" + } + }, + "rootSquash": { + "$ref": "#/definitions/ShareRootSquash", + "description": "The root squash setting.", + "xml": { + "name": "RootSquash" + } + }, + "enableSnapshotVirtualDirectoryAccess": { + "type": "boolean", + "description": "Whether snapshot virtual directory access is enabled.", + "xml": { + "name": "EnableSnapshotVirtualDirectoryAccess" + } + }, + "paidBurstingEnabled": { + "type": "boolean", + "description": "Whether paid bursting is enabled.", + "xml": { + "name": "PaidBurstingEnabled" + } + }, + "paidBurstingMaxIops": { + "type": "integer", + "format": "int64", + "description": "The maximum IOPS for paid bursting.", + "xml": { + "name": "PaidBurstingMaxIops" + } + }, + "paidBurstingMaxBandwidthMibps": { + "type": "integer", + "format": "int64", + "description": "The maximum bandwidth for paid bursting in MiBps.", + "xml": { + "name": "PaidBurstingMaxBandwidthMibps" + } + }, + "includedBurstIops": { + "type": "integer", + "format": "int64", + "description": "The included burst IOPS.", + "xml": { + "name": "IncludedBurstIops" + } + }, + "maxBurstCreditsForIops": { + "type": "integer", + "format": "int64", + "description": "The maximum burst credits for IOPS.", + "xml": { + "name": "MaxBurstCreditsForIops" + } + }, + "nextAllowedProvisionedIopsDowngradeTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The next allowed provisioned IOPS downgrade time.", + "xml": { + "name": "NextAllowedProvisionedIopsDowngradeTime" + } + }, + "nextAllowedProvisionedBandwidthDowngradeTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The next allowed provisioned bandwidth downgrade time.", + "xml": { + "name": "NextAllowedProvisionedBandwidthDowngradeTime" + } + }, + "enableSmbDirectoryLease": { + "type": "boolean", + "description": "Whether SMB directory lease is enabled.", + "xml": { + "name": "EnableSmbDirectoryLease" + } + } + }, + "required": [ + "lastModified", + "eTag", + "quota" + ] + }, + "ShareProtocolSettings": { + "type": "object", + "description": "Protocol settings", + "properties": { + "smb": { + "$ref": "#/definitions/ShareSmbSettings", + "description": "Settings for SMB protocol.", + "xml": { + "name": "SMB" + } + }, + "nfs": { + "$ref": "#/definitions/ShareNfsSettings", + "description": "Settings for NFS protocol.", + "xml": { + "name": "NFS" + } + } + }, + "xml": { + "name": "ProtocolSettings" + } + }, + "ShareRootSquash": { + "type": "string", + "description": "The root squash setting for the share.", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false, + "values": [ + { + "name": "NoRootSquash", + "value": "NoRootSquash", + "description": "NoRootSquash" + }, + { + "name": "RootSquash", + "value": "RootSquash", + "description": "RootSquash" + }, + { + "name": "AllSquash", + "value": "AllSquash", + "description": "AllSquash" + } + ] + } + }, + "ShareSmbSettings": { + "type": "object", + "description": "Settings for SMB protocol.", + "properties": { + "multichannel": { + "$ref": "#/definitions/SmbMultichannel", + "description": "Settings for SMB Multichannel.", + "xml": { + "name": "Multichannel" + } + }, + "encryptionInTransit": { + "$ref": "#/definitions/ShareSmbSettingsEncryptionInTransit", + "description": "Enable or disable encryption in transit.", + "xml": { + "name": "EncryptionInTransit" + } + } + }, + "xml": { + "name": "SMB" + } + }, + "ShareSmbSettingsEncryptionInTransit": { + "type": "object", + "description": "Enable or disable encryption in transit.", + "properties": { + "required": { + "type": "boolean", + "description": "If encryption in transit is required", + "xml": { + "name": "Required" + } + } + } + }, + "ShareStats": { + "type": "object", + "description": "Stats for the share.", + "properties": { + "shareUsageBytes": { + "type": "integer", + "format": "int32", + "description": "The approximate size of the data stored in bytes. Note that this value may not\ninclude all recently created or recently resized files.", + "xml": { + "name": "ShareUsageBytes" + } + } + }, + "required": [ + "shareUsageBytes" + ] + }, + "ShareTokenIntent": { + "type": "string", + "description": "The share token intent.", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true, + "values": [ + { + "name": "backup", + "value": "backup", + "description": "backup" + } + ] + } + }, + "SignedIdentifier": { + "type": "object", + "description": "Signed identifier.", + "properties": { + "id": { + "type": "string", + "description": "A unique id.", + "xml": { + "name": "Id" + } + }, + "accessPolicy": { + "$ref": "#/definitions/AccessPolicy", + "description": "The access policy.", + "xml": { + "name": "AccessPolicy" + } + } + }, + "required": [ + "id" + ] + }, + "SignedIdentifiers": { + "type": "object", + "description": "Represents an array of signed identifiers", + "properties": { + "items": { + "type": "array", + "description": "The array of signed identifiers.", + "items": { + "$ref": "#/definitions/SignedIdentifier" + }, + "xml": { + "name": "SignedIdentifier", + "wrapped": false + } + } + }, + "required": [ + "items" + ] + }, + "SmbMultichannel": { + "type": "object", + "description": "Settings for SMB multichannel", + "properties": { + "enabled": { + "type": "boolean", + "description": "If SMB multichannel is enabled.", + "xml": { + "name": "Enabled" + } + } + }, + "xml": { + "name": "Multichannel" + } + }, + "StorageErrorCode": { + "type": "string", + "description": "Error codes returned by the service", + "enum": [ + "AccountAlreadyExists", + "AccountBeingCreated", + "AccountIsDisabled", + "AuthenticationFailed", + "AuthorizationFailure", + "ConditionHeadersNotSupported", + "ConditionNotMet", + "EmptyMetadataKey", + "FileShareProvisionedBandwidthDowngradeNotAllowed", + "FileShareProvisionedIopsDowngradeNotAllowed", + "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", + "PreviousSnapshotNotFound", + "ContainerQuotaDowngradeNotAllowed", + "AuthorizationSourceIPMismatch", + "AuthorizationProtocolMismatch", + "AuthorizationPermissionMismatch", + "AuthorizationServiceMismatch", + "AuthorizationResourceTypeMismatch", + "FeatureVersionMismatch", + "ShareSnapshotNotFound", + "FileShareProvisionedIopsInvalid", + "FileShareProvisionedBandwidthInvalid", + "FileShareProvisionedStorageInvalid", + "TotalSharesProvisionedCapacityExceedsAccountLimit", + "TotalSharesProvisionedIopsExceedsAccountLimit", + "TotalSharesProvisionedBandwidthExceedsAccountLimit", + "TotalSharesCountExceedsAccountLimit" + ], + "x-ms-enum": { + "name": "StorageErrorCode", + "modelAsString": true, + "values": [ + { + "name": "AccountAlreadyExists", + "value": "AccountAlreadyExists", + "description": "AccountAlreadyExists" + }, + { + "name": "AccountBeingCreated", + "value": "AccountBeingCreated", + "description": "AccountBeingCreated" + }, + { + "name": "AccountIsDisabled", + "value": "AccountIsDisabled", + "description": "AccountIsDisabled" + }, + { + "name": "AuthenticationFailed", + "value": "AuthenticationFailed", + "description": "AuthenticationFailed" + }, + { + "name": "AuthorizationFailure", + "value": "AuthorizationFailure", + "description": "AuthorizationFailure" + }, + { + "name": "ConditionHeadersNotSupported", + "value": "ConditionHeadersNotSupported", + "description": "ConditionHeadersNotSupported" + }, + { + "name": "ConditionNotMet", + "value": "ConditionNotMet", + "description": "ConditionNotMet" + }, + { + "name": "EmptyMetadataKey", + "value": "EmptyMetadataKey", + "description": "EmptyMetadataKey" + }, + { + "name": "FileShareProvisionedBandwidthDowngradeNotAllowed", + "value": "FileShareProvisionedBandwidthDowngradeNotAllowed", + "description": "FileShareProvisionedBandwidthDowngradeNotAllowed" + }, + { + "name": "FileShareProvisionedIopsDowngradeNotAllowed", + "value": "FileShareProvisionedIopsDowngradeNotAllowed", + "description": "FileShareProvisionedIopsDowngradeNotAllowed" + }, + { + "name": "InsufficientAccountPermissions", + "value": "InsufficientAccountPermissions", + "description": "InsufficientAccountPermissions" + }, + { + "name": "InternalError", + "value": "InternalError", + "description": "InternalError" + }, + { + "name": "InvalidAuthenticationInfo", + "value": "InvalidAuthenticationInfo", + "description": "InvalidAuthenticationInfo" + }, + { + "name": "InvalidHeaderValue", + "value": "InvalidHeaderValue", + "description": "InvalidHeaderValue" + }, + { + "name": "InvalidHttpVerb", + "value": "InvalidHttpVerb", + "description": "InvalidHttpVerb" + }, + { + "name": "InvalidInput", + "value": "InvalidInput", + "description": "InvalidInput" + }, + { + "name": "InvalidMd5", + "value": "InvalidMd5", + "description": "InvalidMd5" + }, + { + "name": "InvalidMetadata", + "value": "InvalidMetadata", + "description": "InvalidMetadata" + }, + { + "name": "InvalidQueryParameterValue", + "value": "InvalidQueryParameterValue", + "description": "InvalidQueryParameterValue" + }, + { + "name": "InvalidRange", + "value": "InvalidRange", + "description": "InvalidRange" + }, + { + "name": "InvalidResourceName", + "value": "InvalidResourceName", + "description": "InvalidResourceName" + }, + { + "name": "InvalidUri", + "value": "InvalidUri", + "description": "InvalidUri" + }, + { + "name": "InvalidXmlDocument", + "value": "InvalidXmlDocument", + "description": "InvalidXmlDocument" + }, + { + "name": "InvalidXmlNodeValue", + "value": "InvalidXmlNodeValue", + "description": "InvalidXmlNodeValue" + }, + { + "name": "Md5Mismatch", + "value": "Md5Mismatch", + "description": "Md5Mismatch" + }, + { + "name": "MetadataTooLarge", + "value": "MetadataTooLarge", + "description": "MetadataTooLarge" + }, + { + "name": "MissingContentLengthHeader", + "value": "MissingContentLengthHeader", + "description": "MissingContentLengthHeader" + }, + { + "name": "MissingRequiredQueryParameter", + "value": "MissingRequiredQueryParameter", + "description": "MissingRequiredQueryParameter" + }, + { + "name": "MissingRequiredHeader", + "value": "MissingRequiredHeader", + "description": "MissingRequiredHeader" + }, + { + "name": "MissingRequiredXmlNode", + "value": "MissingRequiredXmlNode", + "description": "MissingRequiredXmlNode" + }, + { + "name": "MultipleConditionHeadersNotSupported", + "value": "MultipleConditionHeadersNotSupported", + "description": "MultipleConditionHeadersNotSupported" + }, + { + "name": "OperationTimedOut", + "value": "OperationTimedOut", + "description": "OperationTimedOut" + }, + { + "name": "OutOfRangeInput", + "value": "OutOfRangeInput", + "description": "OutOfRangeInput" + }, + { + "name": "OutOfRangeQueryParameterValue", + "value": "OutOfRangeQueryParameterValue", + "description": "OutOfRangeQueryParameterValue" + }, + { + "name": "RequestBodyTooLarge", + "value": "RequestBodyTooLarge", + "description": "RequestBodyTooLarge" + }, + { + "name": "ResourceTypeMismatch", + "value": "ResourceTypeMismatch", + "description": "ResourceTypeMismatch" + }, + { + "name": "RequestUrlFailedToParse", + "value": "RequestUrlFailedToParse", + "description": "RequestUrlFailedToParse" + }, + { + "name": "ResourceAlreadyExists", + "value": "ResourceAlreadyExists", + "description": "ResourceAlreadyExists" + }, + { + "name": "ResourceNotFound", + "value": "ResourceNotFound", + "description": "ResourceNotFound" + }, + { + "name": "ServerBusy", + "value": "ServerBusy", + "description": "ServerBusy" + }, + { + "name": "UnsupportedHeader", + "value": "UnsupportedHeader", + "description": "UnsupportedHeader" + }, + { + "name": "UnsupportedXmlNode", + "value": "UnsupportedXmlNode", + "description": "UnsupportedXmlNode" + }, + { + "name": "UnsupportedQueryParameter", + "value": "UnsupportedQueryParameter", + "description": "UnsupportedQueryParameter" + }, + { + "name": "UnsupportedHttpVerb", + "value": "UnsupportedHttpVerb", + "description": "UnsupportedHttpVerb" + }, + { + "name": "CannotDeleteFileOrDirectory", + "value": "CannotDeleteFileOrDirectory", + "description": "CannotDeleteFileOrDirectory" + }, + { + "name": "ClientCacheFlushDelay", + "value": "ClientCacheFlushDelay", + "description": "ClientCacheFlushDelay" + }, + { + "name": "DeletePending", + "value": "DeletePending", + "description": "DeletePending" + }, + { + "name": "DirectoryNotEmpty", + "value": "DirectoryNotEmpty", + "description": "DirectoryNotEmpty" + }, + { + "name": "FileLockConflict", + "value": "FileLockConflict", + "description": "FileLockConflict" + }, + { + "name": "InvalidFileOrDirectoryPathName", + "value": "InvalidFileOrDirectoryPathName", + "description": "InvalidFileOrDirectoryPathName" + }, + { + "name": "ParentNotFound", + "value": "ParentNotFound", + "description": "ParentNotFound" + }, + { + "name": "ReadOnlyAttribute", + "value": "ReadOnlyAttribute", + "description": "ReadOnlyAttribute" + }, + { + "name": "ShareAlreadyExists", + "value": "ShareAlreadyExists", + "description": "ShareAlreadyExists" + }, + { + "name": "ShareBeingDeleted", + "value": "ShareBeingDeleted", + "description": "ShareBeingDeleted" + }, + { + "name": "ShareDisabled", + "value": "ShareDisabled", + "description": "ShareDisabled" + }, + { + "name": "ShareNotFound", + "value": "ShareNotFound", + "description": "ShareNotFound" + }, + { + "name": "SharingViolation", + "value": "SharingViolation", + "description": "SharingViolation" + }, + { + "name": "ShareSnapshotInProgress", + "value": "ShareSnapshotInProgress", + "description": "ShareSnapshotInProgress" + }, + { + "name": "ShareSnapshotCountExceeded", + "value": "ShareSnapshotCountExceeded", + "description": "ShareSnapshotCountExceeded" + }, + { + "name": "ShareSnapshotOperationNotSupported", + "value": "ShareSnapshotOperationNotSupported", + "description": "ShareSnapshotOperationNotSupported" + }, + { + "name": "ShareHasSnapshots", + "value": "ShareHasSnapshots", + "description": "ShareHasSnapshots" + }, + { + "name": "PreviousSnapshotNotFound", + "value": "PreviousSnapshotNotFound", + "description": "PreviousSnapshotNotFound" + }, + { + "name": "ContainerQuotaDowngradeNotAllowed", + "value": "ContainerQuotaDowngradeNotAllowed", + "description": "ContainerQuotaDowngradeNotAllowed" + }, + { + "name": "AuthorizationSourceIPMismatch", + "value": "AuthorizationSourceIPMismatch", + "description": "AuthorizationSourceIPMismatch" + }, + { + "name": "AuthorizationProtocolMismatch", + "value": "AuthorizationProtocolMismatch", + "description": "AuthorizationProtocolMismatch" + }, + { + "name": "AuthorizationPermissionMismatch", + "value": "AuthorizationPermissionMismatch", + "description": "AuthorizationPermissionMismatch" + }, + { + "name": "AuthorizationServiceMismatch", + "value": "AuthorizationServiceMismatch", + "description": "AuthorizationServiceMismatch" + }, + { + "name": "AuthorizationResourceTypeMismatch", + "value": "AuthorizationResourceTypeMismatch", + "description": "AuthorizationResourceTypeMismatch" + }, + { + "name": "FeatureVersionMismatch", + "value": "FeatureVersionMismatch", + "description": "FeatureVersionMismatch" + }, + { + "name": "ShareSnapshotNotFound", + "value": "ShareSnapshotNotFound", + "description": "ShareSnapshotNotFound" + }, + { + "name": "FileShareProvisionedIopsInvalid", + "value": "FileShareProvisionedIopsInvalid", + "description": "FileShareProvisionedIopsInvalid" + }, + { + "name": "FileShareProvisionedBandwidthInvalid", + "value": "FileShareProvisionedBandwidthInvalid", + "description": "FileShareProvisionedBandwidthInvalid" + }, + { + "name": "FileShareProvisionedStorageInvalid", + "value": "FileShareProvisionedStorageInvalid", + "description": "FileShareProvisionedStorageInvalid" + }, + { + "name": "TotalSharesProvisionedCapacityExceedsAccountLimit", + "value": "TotalSharesProvisionedCapacityExceedsAccountLimit", + "description": "TotalSharesProvisionedCapacityExceedsAccountLimit" + }, + { + "name": "TotalSharesProvisionedIopsExceedsAccountLimit", + "value": "TotalSharesProvisionedIopsExceedsAccountLimit", + "description": "TotalSharesProvisionedIopsExceedsAccountLimit" + }, + { + "name": "TotalSharesProvisionedBandwidthExceedsAccountLimit", + "value": "TotalSharesProvisionedBandwidthExceedsAccountLimit", + "description": "TotalSharesProvisionedBandwidthExceedsAccountLimit" + }, + { + "name": "TotalSharesCountExceedsAccountLimit", + "value": "TotalSharesCountExceedsAccountLimit", + "description": "TotalSharesCountExceedsAccountLimit" + } + ] + } + }, + "StorageServiceProperties": { + "type": "object", + "description": "Storage service properties.", + "properties": { + "hourMetrics": { + "$ref": "#/definitions/Metrics", + "description": "A summary of request statistics grouped by API in hourly aggregates for files.", + "xml": { + "name": "HourMetrics" + } + }, + "minuteMetrics": { + "$ref": "#/definitions/Metrics", + "description": "A summary of request statistics grouped by API in minute aggregates for files.", + "xml": { + "name": "MinuteMetrics" + } + }, + "protocol": { + "$ref": "#/definitions/ShareProtocolSettings", + "description": "Protocol settings", + "xml": { + "name": "ProtocolSettings" + } + }, + "cors": { + "type": "array", + "description": "The set of CORS rules.", + "items": { + "$ref": "#/definitions/CorsRule" + }, + "xml": { + "name": "Cors", + "wrapped": true + } + } + } + }, + "StringEncoded": { + "type": "object", + "description": "An encoded string value.", + "properties": { + "encoded": { + "type": "boolean", + "description": "Whether the value is encoded.", + "xml": { + "name": "Encoded", + "attribute": true + } + }, + "content": { + "type": "string", + "description": "The string content.", + "xml": { + "x-ms-text": true + } + } + } + }, + "UserDelegationKey": { + "type": "object", + "description": "A user delegation key", + "properties": { + "signedOid": { + "type": "string", + "description": "The Azure Active Directory object ID in GUID format.", + "xml": { + "name": "SignedOid" + } + }, + "signedTid": { + "type": "string", + "description": "The Azure Active Directory tenant ID in GUID format", + "xml": { + "name": "SignedTid" + } + }, + "signedStart": { + "type": "string", + "format": "date-time", + "description": "The date-time the key is active", + "xml": { + "name": "SignedStart" + } + }, + "signedExpiry": { + "type": "string", + "format": "date-time", + "description": "The date-time the key expires", + "xml": { + "name": "SignedExpiry" + } + }, + "signedService": { + "type": "string", + "description": "Abbreviation of the Azure Storage service that accepts the key", + "xml": { + "name": "SignedService" + } + }, + "signedVersion": { + "type": "string", + "description": "The service version that created the key", + "xml": { + "name": "SignedVersion" + } + }, + "signedDelegatedUserTid": { + "type": "string", + "description": "The delegated user tenant id in Azure AD. Return if DelegatedUserTid is\nspecified.", + "xml": { + "name": "SignedDelegatedUserTid" + } + }, + "value": { + "type": "string", + "description": "The key as a base64 string", + "xml": { + "name": "Value" + } + } + }, + "required": [ + "signedOid", + "signedTid", + "signedStart", + "signedExpiry", + "signedService", + "signedVersion", + "value" + ] + } + }, + "parameters": {} +}