diff --git a/specification/storage/data-plane/Azure.Storage.Files.DataLake/stable/2026-06-06/DataLakeStorage.json b/specification/storage/data-plane/Azure.Storage.Files.DataLake/stable/2026-06-06/DataLakeStorage.json index 700a4530a3b1..c0ad06f870dc 100644 --- a/specification/storage/data-plane/Azure.Storage.Files.DataLake/stable/2026-06-06/DataLakeStorage.json +++ b/specification/storage/data-plane/Azure.Storage.Files.DataLake/stable/2026-06-06/DataLakeStorage.json @@ -1,50 +1,82 @@ { "swagger": "2.0", "info": { - "description": "Azure Data Lake Storage provides storage for Hadoop and other big data workloads.", "title": "Azure Data Lake Storage REST API", "version": "2026-06-06", - "x-ms-code-generation-settings": { - "internalConstructors": true, - "name": "DataLakeStorageClient", - "header": "MIT", - "strictSpecAdherence": false - } + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, + "schemes": [ + "https" + ], "x-ms-parameterized-host": { "hostTemplate": "{url}", "useSchemePrefix": false, - "positionInOperation": "first", "parameters": [ { - "$ref": "#/parameters/Url" + "name": "url", + "in": "path", + "description": "The URL of the service account, container, or blob that is the target of the desired operation.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true } ] }, - "schemes": [ - "https" + "produces": [ + "application/json", + "application/xml" ], "consumes": [ "application/json" ], - "produces": [ - "application/json" + "security": [ + { + "OAuth2Auth": [ + "https://storage.azure.com/.default" + ] + } ], - "paths": {}, - "x-ms-paths": { + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://storage.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { "/": { "get": { "operationId": "Service_ListFileSystems", - "summary": "List FileSystems", "description": "List filesystems and their properties in given account.", - "x-ms-pageable": { - "itemName": "filesystems", - "nextLinkName": null - }, - "tags": [ - "Account Operations" + "produces": [ + "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": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, { "name": "resource", "in": "query", @@ -56,2772 +88,4144 @@ ], "x-ms-enum": { "name": "AccountResourceType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "name": "account", + "value": "account", + "description": "The account resource type." + } + ] } }, { - "$ref": "#/parameters/Prefix" - }, - { - "$ref": "#/parameters/Continuation" - }, - { - "$ref": "#/parameters/MaxResults" + "name": "prefix", + "in": "query", + "description": "Filters results to filesystems within the specified prefix.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/ClientRequestId" + "name": "continuation", + "in": "query", + "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/Timeout" + "name": "maxResults", + "in": "query", + "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 }, { - "$ref": "#/parameters/ApiVersionParameter" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { "200": { - "description": "OK", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/FileSystemList" + }, "headers": { "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, "x-ms-continuation": { - "x-ms-client-name": "Continuation", - "description": "If the number of filesystems to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.", - "type": "string" + "type": "string", + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths." }, - "Content-Type": { - "description": "The content type of list filesystem response. The default content type is application/json.", - "type": "string" + "x-ms-request-id": { + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." } - }, - "schema": { - "$ref": "#/definitions/FileSystemList" } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - } - }, - "/{filesystem}": { + }, "put": { "operationId": "FileSystem_Create", - "summary": "Create FileSystem", - "description": "Create a FileSystem rooted at the specified location. If the FileSystem already exists, the operation fails. This operation does not support conditional HTTP requests.", - "tags": [ - "FileSystem Operations" + "description": "Create a FileSystem rooted at the specified location. If the FileSystem already exists, the operation fails. This operation does not support conditional HTTP requests.", + "produces": [ + "application/json" ], "parameters": [ { - "$ref": "#/parameters/Properties" + "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": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "resource", + "in": "query", + "description": "The value must be \"filesystem\" for all filesystem operations.", + "required": true, + "type": "string", + "enum": [ + "filesystem" + ], + "x-ms-enum": { + "name": "FileSystemResourceType", + "modelAsString": false, + "values": [ + { + "name": "filesystem", + "value": "filesystem", + "description": "The filesystem resource type." + } + ] + } + }, + { + "name": "x-ms-properties", + "in": "header", + "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "required": false, + "type": "string", + "x-ms-client-name": "properties" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { "201": { - "description": "Created", + "description": "The request has succeeded and a new resource has been created as a result.", "headers": { "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { - "description": "An HTTP entity tag associated with the FileSystem.", - "type": "string" + "type": "string", + "description": "An HTTP entity tag associated with the resource." }, "Last-Modified": { - "description": "The data and time the filesystem was last modified. Operations on files and directories do not affect the last modified time.", - "format": "date-time-rfc1123", - "type": "string" + "type": "string", + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "x-ms-namespace-enabled": { + "type": "string", + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem." }, "x-ms-request-id": { - "x-ms-client-name": "ClientRequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-namespace-enabled": { - "x-ms-client-name": "NamespaceEnabled", - "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.", - "type": "string" + "type": "string", + "description": "Specifies the version of the operation to use for this request." } } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } }, - "patch": { - "operationId": "FileSystem_SetProperties", - "summary": "Set FileSystem Properties", - "description": "Set properties for the FileSystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "tags": [ - "FileSystem Operations" + "post": { + "operationId": "Path_Lease", + "description": "Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "produces": [ + "application/json" ], "parameters": [ { - "$ref": "#/parameters/Properties" + "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": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "There are five lease actions: \"acquire\", \"break\", \"change\", \"renew\", and \"release\". Use \"acquire\" and specify the \"x-ms-proposed-lease-id\" and \"x-ms-lease-duration\" to acquire a new lease. Use \"break\" to break an existing lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. Use \"change\" and specify the current lease ID in \"x-ms-lease-id\" and the new lease ID in \"x-ms-proposed-lease-id\" to change the lease ID of an active lease. Use \"renew\" and specify the \"x-ms-lease-id\" to renew an existing lease. Use \"release\" and specify the \"x-ms-lease-id\" to release a lease.", + "required": true, + "type": "string", + "enum": [ + "acquire", + "break", + "change", + "renew", + "release" + ], + "x-ms-enum": { + "name": "PathLeaseAction", + "modelAsString": false, + "values": [ + { + "name": "acquire", + "value": "acquire", + "description": "Acquire a new lease." + }, + { + "name": "break", + "value": "break", + "description": "Break an existing lease." + }, + { + "name": "change", + "value": "change", + "description": "Change the lease ID of an active lease." + }, + { + "name": "renew", + "value": "renew", + "description": "Renew an existing lease." + }, + { + "name": "release", + "value": "release", + "description": "Release a lease." + } + ] + }, + "x-ms-client-name": "leaseAction" + }, + { + "name": "x-ms-lease-duration", + "in": "header", + "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-client-name": "leaseDuration" + }, + { + "name": "x-ms-lease-break-period", + "in": "header", + "description": "The lease break period duration is optional to break a lease, and specifies the break period of the lease in seconds. The lease break duration must be between 0 and 60 seconds.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-client-name": "leaseBreakPeriod" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "description": "Proposed lease ID, in a GUID string format.", + "required": false, + "type": "string", + "x-ms-client-name": "proposedLeaseId" + }, + { + "name": "If-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs with a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs without a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" }, { - "$ref": "#/parameters/IfModifiedSince" + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" }, { - "$ref": "#/parameters/IfUnmodifiedSince" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { "200": { - "description": "Ok", + "description": "The request has succeeded.", "headers": { "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { - "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", - "type": "string" + "type": "string", + "description": "An HTTP entity tag associated with the resource." }, "Last-Modified": { - "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", - "format": "date-time-rfc1123", - "type": "string" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" + "type": "string", + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "head": { - "operationId": "FileSystem_GetProperties", - "summary": "Get FileSystem Properties.", - "description": "All system and user-defined filesystem properties are specified in the response headers.", - "tags": [ - "FileSystem Operations" - ], - "responses": { - "200": { - "description": "Ok", - "headers": { - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "x-ms-client-request-id": { "type": "string", - "format": "date-time-rfc1123" + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, - "ETag": { - "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", - "type": "string" + "x-ms-lease-id": { + "type": "string", + "description": "A successful lease action returns the lease ID." }, - "Last-Modified": { - "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", - "format": "date-time-rfc1123", - "type": "string" + "x-ms-lease-time": { + "type": "string", + "description": "The time remaining in the lease period in seconds." }, "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-properties": { - "x-ms-client-name": "Properties", - "description": "The user-defined properties associated with the filesystem. A comma-separated list of name and value pairs in the format \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "type": "string" - }, - "x-ms-namespace-enabled": { - "x-ms-client-name": "NamespaceEnabled", - "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.", - "type": "string" + "type": "string", + "description": "Specifies the version of the operation to use for this request." } } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } }, - "delete": { - "operationId": "FileSystem_Delete", - "summary": "Delete FileSystem", - "description": "Marks the FileSystem for deletion. When a FileSystem is deleted, a FileSystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "tags": [ - "FileSystem Operations" + "patch": { + "operationId": "FileSystem_SetProperties", + "description": "Set properties for the FileSystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "produces": [ + "application/json" ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string", - "format": "date-time-rfc1123" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - }, "parameters": [ { - "$ref": "#/parameters/IfModifiedSince" + "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" }, { - "$ref": "#/parameters/IfUnmodifiedSince" - } - ] - }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "$ref": "#/parameters/FileSystemResource" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ] - }, - "/{filesystem}?resource=filesystem": { - "get": { - "operationId": "FileSystem_ListPaths", - "summary": "List Paths", - "description": "List FileSystem paths and their properties.", - "x-ms-pageable": { - "itemName": "paths", - "nextLinkName": null - }, - "tags": [ - "FileSystem Operations" - ], - "parameters": [ - { - "$ref": "#/parameters/Continuation" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "$ref": "#/parameters/Directory" + "name": "resource", + "in": "query", + "description": "The value must be \"filesystem\" for all filesystem operations.", + "required": true, + "type": "string", + "enum": [ + "filesystem" + ], + "x-ms-enum": { + "name": "FileSystemResourceType", + "modelAsString": false, + "values": [ + { + "name": "filesystem", + "value": "filesystem", + "description": "The filesystem resource type." + } + ] + } }, { - "$ref": "#/parameters/RecursiveRequired" + "name": "x-ms-properties", + "in": "header", + "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "required": false, + "type": "string", + "x-ms-client-name": "properties" }, { - "$ref": "#/parameters/MaxResults" + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" }, { - "$ref": "#/parameters/Upn" + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" }, { - "$ref": "#/parameters/BeginFrom" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { "200": { - "description": "Ok", + "description": "The request has succeeded.", "headers": { "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { - "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", - "type": "string" + "type": "string", + "description": "An HTTP entity tag associated with the resource." }, "Last-Modified": { - "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", - "format": "date-time-rfc1123", - "type": "string" + "type": "string", + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-continuation": { - "x-ms-client-name": "Continuation", - "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.", - "type": "string" + "type": "string", + "description": "Specifies the version of the operation to use for this request." } - }, - "schema": { - "$ref": "#/definitions/PathList" } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "$ref": "#/parameters/FileSystemResource" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ] - }, - "/{filesystem}?restype=container&comp=list&hierarchy": { - "get": { - "tags": [ - "containers" - ], + "delete": { + "operationId": "FileSystem_Delete", + "description": "Marks the FileSystem for deletion. When a FileSystem is deleted, a FileSystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", "produces": [ - "application/xml" + "application/json" ], - "operationId": "FileSystem_ListBlobHierarchySegment", - "description": "The List Blobs operation returns a list of the blobs under the specified container", "parameters": [ { - "$ref": "#/parameters/Prefix" - }, - { - "$ref": "#/parameters/Delimiter" - }, - { - "$ref": "#/parameters/Marker" - }, - { - "$ref": "#/parameters/MaxResults" + "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" }, { - "$ref": "#/parameters/ListBlobsInclude" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "$ref": "#/parameters/ListBlobsShowOnly" + "name": "resource", + "in": "query", + "description": "The value must be \"filesystem\" for all filesystem operations.", + "required": true, + "type": "string", + "enum": [ + "filesystem" + ], + "x-ms-enum": { + "name": "FileSystemResourceType", + "modelAsString": false, + "values": [ + { + "name": "filesystem", + "value": "filesystem", + "description": "The filesystem resource type." + } + ] + } }, { - "$ref": "#/parameters/Timeout" + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" }, { - "$ref": "#/parameters/ApiVersionParameter" + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" }, { - "$ref": "#/parameters/ClientRequestId" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { - "200": { - "description": "Success.", + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "Content-Type": { + "Date": { "type": "string", - "description": "The media type of the body of the response. For List Blobs this is 'application/xml'" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, "x-ms-request-id": { - "x-ms-client-name": "RequestId", "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "Specifies the version of the operation to use for this request." } - }, - "schema": { - "$ref": "#/definitions/ListBlobsHierarchySegmentResponse" } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } - }, - "x-ms-pageable": { - "nextLinkName": "NextMarker" } }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "name": "restype", - "description": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "container" - ] - }, - { - "name": "comp", - "description": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "list" - ] - } - ] - }, - "/{filesystem}/{path}": { - "put": { - "operationId": "Path_Create", - "summary": "Create File | Create Directory | Rename File | Rename Directory", - "description": "Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", - "consumes": [ - "application/octet-stream" - ], - "tags": [ - "File and Directory Operations" + "head": { + "operationId": "FileSystem_GetProperties", + "description": "All system and user-defined filesystem properties are specified in the response headers.", + "produces": [ + "application/json" ], "parameters": [ { - "name": "resource", - "in": "query", - "description": "Required only for Create File and Create Directory. The value must be \"file\" or \"directory\".", - "required": false, + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, "type": "string", - "enum": [ - "directory", - "file" - ], - "x-ms-enum": { - "name": "PathResourceType", - "modelAsString": false - } + "x-ms-client-name": "version" }, { - "$ref": "#/parameters/Continuation" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "name": "mode", + "name": "resource", "in": "query", - "description": "Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be \"legacy\" or \"posix\", and the default value will be \"posix\".", - "required": false, + "description": "The value must be \"filesystem\" for all filesystem operations.", + "required": true, "type": "string", "enum": [ - "legacy", - "posix" + "filesystem" ], "x-ms-enum": { - "name": "PathRenameMode", - "modelAsString": false + "name": "FileSystemResourceType", + "modelAsString": false, + "values": [ + { + "name": "filesystem", + "value": "filesystem", + "description": "The filesystem resource type." + } + ] } }, { - "$ref": "#/parameters/CacheControl" - }, - { - "$ref": "#/parameters/ContentEncoding" - }, - { - "$ref": "#/parameters/ContentLanguage" - }, - { - "$ref": "#/parameters/ContentDisposition" - }, - { - "$ref": "#/parameters/ContentType" - }, - { - "$ref": "#/parameters/RenameSource" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/SourceLeaseId" - }, - { - "$ref": "#/parameters/Properties" - }, - { - "$ref": "#/parameters/Permissions" - }, - { - "$ref": "#/parameters/Umask" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" - }, - { - "$ref": "#/parameters/IfModifiedSince" - }, - { - "$ref": "#/parameters/IfUnmodifiedSince" - }, - { - "$ref": "#/parameters/SourceIfMatch" - }, - { - "$ref": "#/parameters/SourceIfNoneMatch" - }, - { - "$ref": "#/parameters/SourceIfModifiedSince" - }, - { - "$ref": "#/parameters/SourceIfUnmodifiedSince" - }, - { - "$ref": "#/parameters/EncryptionKey" - }, - { - "$ref": "#/parameters/EncryptionKeySha256" - }, - { - "$ref": "#/parameters/EncryptionAlgorithm" - }, - { - "$ref": "#/parameters/Owner" - }, - { - "$ref": "#/parameters/Group" - }, - { - "$ref": "#/parameters/Acl" - }, - { - "$ref": "#/parameters/ProposedLeaseIdOptional" - }, - { - "$ref": "#/parameters/LeaseDurationMethod" - }, - { - "$ref": "#/parameters/PathExpiryOptionsOptional" - }, - { - "$ref": "#/parameters/PathExpiryTime" - }, - { - "$ref": "#/parameters/EncryptionContext" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { - "201": { - "description": "The file or directory was created.", + "200": { + "description": "The request has succeeded.", "headers": { "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", - "type": "string" + "type": "string", + "description": "An HTTP entity tag associated with the resource." }, "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", - "format": "date-time-rfc1123", - "type": "string" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" + "type": "string", + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, - "x-ms-continuation": { - "x-ms-client-name": "Continuation", - "description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.", - "type": "string" + "x-ms-namespace-enabled": { + "type": "string", + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem." }, - "Content-Length": { - "description": "The size of the resource in bytes.", - "type": "integer", - "format": "int64" + "x-ms-properties": { + "type": "string", + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set." }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + "x-ms-request-id": { + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, - "x-ms-encryption-key-sha256": { - "x-ms-client-name": "EncryptionKeySha256", + "x-ms-version": { "type": "string", - "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + "description": "Specifies the version of the operation to use for this request." } } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, + } + } + }, + "x-ms-paths": { + "?action=append": { "patch": { - "operationId": "Path_Update", - "summary": "Append Data | Flush Data | Set Properties | Set Access Control", - "description": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. Concurrent writes to the same file using multiple clients are not supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "operationId": "Path_AppendData", + "description": "Append data to the file.", + "produces": [ + "application/json" + ], "consumes": [ "application/octet-stream" ], - "tags": [ - "File and Directory Operations" - ], "parameters": [ { - "name": "action", - "in": "query", - "description": "The action must be \"append\" to upload data to be appended to a file, \"flush\" to flush previously uploaded data to a file, \"setProperties\" to set the properties of a file or directory, \"setAccessControl\" to set the owner, group, permissions, or access control list for a file or directory, or \"setAccessControlRecursive\" to set the access control list for a directory recursively. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.", + "name": "x-ms-version", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", "required": true, "type": "string", - "enum": [ - "append", - "flush", - "setProperties", - "setAccessControl", - "setAccessControlRecursive" - ], - "x-ms-enum": { - "name": "PathUpdateAction", - "modelAsString": false - } + "x-ms-client-name": "version" }, { - "name": "maxRecords", - "in": "query", - "description": "Optional. Valid for \"SetAccessControlRecursive\" operation. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or greater than 2,000, the request will process up to 2,000 items", - "format": "int32", - "minimum": 1, + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", "required": false, - "type": "integer" + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "name": "continuation", + "name": "position", "in": "query", - "description": "Optional. The number of paths processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be percent-encoded and specified in a subsequent invocation of setAccessControlRecursive operation.", + "description": "This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.", "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/PathSetAccessControlRecursiveMode" - }, - { - "$ref": "#/parameters/ForceFlag" - }, - { - "$ref": "#/parameters/Position" - }, - { - "$ref": "#/parameters/RetainUncommittedData" - }, - { - "$ref": "#/parameters/Close" - }, - { - "$ref": "#/parameters/ContentLength" - }, - { - "$ref": "#/parameters/ContentMD5" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/CacheControl" - }, - { - "$ref": "#/parameters/ContentType" + "type": "integer", + "format": "int64" }, { - "$ref": "#/parameters/ContentDisposition" + "name": "Content-Length", + "in": "header", + "description": "Required for \"Append Data\" and \"Flush Data\". Must be 0 for \"Flush Data\". Must be the length of the request content in bytes for \"Append Data\".", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "contentLength" }, { - "$ref": "#/parameters/ContentEncoding" + "name": "Content-MD5", + "in": "header", + "description": "Specify the transactional md5 for the body, to be validated by the service.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "transactionalContentHash" }, { - "$ref": "#/parameters/ContentLanguage" + "name": "x-ms-content-crc64", + "in": "header", + "description": "Specify the transactional crc64 for the body, to be validated by the service.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "transactionalContentCrc64" }, { - "$ref": "#/parameters/Properties" + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" }, { - "$ref": "#/parameters/Owner" + "name": "x-ms-lease-action", + "in": "header", + "description": "Optional. If \"acquire\" it will acquire the lease. If \"auto-renew\" it will renew the lease. If \"release\" it will release the lease only on flush. If \"acquire-release\" it will acquire & complete the operation & release the lease once operation is done.", + "required": false, + "type": "string", + "enum": [ + "acquire", + "auto-renew", + "release", + "acquire-release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false, + "values": [ + { + "name": "acquire", + "value": "acquire", + "description": "Acquire a lease." + }, + { + "name": "auto-renew", + "value": "auto-renew", + "description": "Auto-renew the lease." + }, + { + "name": "release", + "value": "release", + "description": "Release the lease only on flush." + }, + { + "name": "acquire-release", + "value": "acquire-release", + "description": "Acquire, complete the operation, and release the lease." + } + ] + }, + "x-ms-client-name": "leaseAction" }, { - "$ref": "#/parameters/Group" + "name": "x-ms-lease-duration", + "in": "header", + "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "leaseDuration" }, { - "$ref": "#/parameters/Permissions" + "name": "x-ms-proposed-lease-id", + "in": "header", + "description": "Proposed lease ID, in a GUID string format.", + "required": false, + "type": "string", + "x-ms-client-name": "proposedLeaseId" }, { - "$ref": "#/parameters/Acl" + "name": "x-ms-encryption-key", + "in": "header", + "description": "Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key.", + "required": false, + "type": "string", + "x-ms-client-name": "encryptionKey" }, { - "$ref": "#/parameters/IfMatch" + "name": "x-ms-encryption-key-sha256", + "in": "header", + "description": "The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided.", + "required": false, + "type": "string", + "x-ms-client-name": "encryptionKeySha256" }, { - "$ref": "#/parameters/IfNoneMatch" + "name": "x-ms-encryption-algorithm", + "in": "header", + "description": "The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided.", + "required": false, + "type": "string", + "enum": [ + "AES256" + ], + "x-ms-enum": { + "name": "EncryptionAlgorithmType", + "modelAsString": false, + "values": [ + { + "name": "AES256", + "value": "AES256", + "description": "The AES256 encryption algorithm." + } + ] + }, + "x-ms-client-name": "encryptionAlgorithm" }, { - "$ref": "#/parameters/IfModifiedSince" + "name": "flush", + "in": "query", + "description": "If file should be flushed after the append.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/IfUnmodifiedSince" + "name": "x-ms-structured-body", + "in": "header", + "description": "Required if the request body is a structured message. Specifies the message schema version and properties.", + "required": false, + "type": "string", + "x-ms-client-name": "structuredBodyType" }, { - "$ref": "#/parameters/Body" + "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" }, { - "$ref": "#/parameters/StructuredBodyPut" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 }, { - "$ref": "#/parameters/StructuredContentLength" + "name": "body", + "in": "body", + "description": "Initial data.", + "required": true, + "schema": { + "type": "string", + "format": "binary" + } } ], "responses": { - "200": { - "description": "The data was flushed (written) to the file or the properties were set successfully. Response body is optional and is valid only for \"SetAccessControlRecursive\"", + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "The MD5 hash of the content." + }, "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", - "type": "string" - }, - "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", - "format": "date-time-rfc1123", - "type": "string" - }, - "Accept-Ranges": { - "description": "Indicates that the service supports requests for partial file content.", - "type": "string" - }, - "Cache-Control": { - "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Disposition": { - "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Encoding": { - "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Language": { - "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Length": { - "description": "The size of the resource in bytes.", - "type": "integer", - "format": "int64" - }, - "Content-Range": { - "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", - "type": "string" + "type": "string", + "description": "An HTTP entity tag associated with the resource." }, - "Content-Type": { - "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", - "type": "string" + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, - "Content-MD5": { - "description": "An MD5 hash of the request content. This header is only returned for \"Flush\" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content.", - "type": "string" + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." }, - "x-ms-properties": { - "x-ms-client-name": "Properties", - "description": "User-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "type": "string" + "x-ms-encryption-key-sha256": { + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." }, - "x-ms-continuation": { - "description": "When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory.", - "type": "string" + "x-ms-lease-renewed": { + "type": "boolean", + "description": "If the lease was auto-renewed with this request." }, "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/SetAccessControlRecursiveResponse" - } - }, - "202": { - "description": "The uploaded data was accepted.", - "headers": { - "Content-MD5": { - "description": "An MD5 hash of the request content. This header is only returned for \"Append\" operation. This header is returned so that the client can check for message content integrity. The value of this header is computed by the service; it is not necessarily the same value specified in the request headers.", - "type": "string" - }, - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" + "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 using the specified algorithm, and false otherwise." }, "x-ms-structured-body": { - "x-ms-client-name": "StructuredBodyType", "type": "string", "description": "Indicates the structured message body was accepted and mirrors back 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": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, - "post": { - "operationId": "Path_Lease", - "summary": "Lease Path", - "description": "Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "tags": [ - "File and Directory Operations" + } + }, + "?action=flush": { + "patch": { + "operationId": "Path_FlushData", + "description": "Set the owner, group, permissions, or access control list for a path.", + "produces": [ + "application/json" ], "parameters": [ { - "name": "x-ms-lease-action", + "name": "x-ms-version", "in": "header", - "description": "There are five lease actions: \"acquire\", \"break\", \"change\", \"renew\", and \"release\". Use \"acquire\" and specify the \"x-ms-proposed-lease-id\" and \"x-ms-lease-duration\" to acquire a new lease. Use \"break\" to break an existing lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. Use \"change\" and specify the current lease ID in \"x-ms-lease-id\" and the new lease ID in \"x-ms-proposed-lease-id\" to change the lease ID of an active lease. Use \"renew\" and specify the \"x-ms-lease-id\" to renew an existing lease. Use \"release\" and specify the \"x-ms-lease-id\" to release a lease.", + "description": "Specifies the version of the operation to use for this request.", "required": true, "type": "string", - "enum": [ - "acquire", - "break", - "change", - "renew", - "release" - ], - "x-ms-enum": { - "name": "PathLeaseAction", - "modelAsString": false - } + "x-ms-client-name": "version" }, { - "$ref": "#/parameters/LeaseDuration" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "name": "x-ms-lease-break-period", - "in": "header", - "description": "The lease break period duration is optional to break a lease, and specifies the break period of the lease in seconds. The lease break duration must be between 0 and 60 seconds.", - "format": "int32", + "name": "position", + "in": "query", + "description": "This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.", "required": false, - "type": "integer" + "type": "integer", + "format": "int64" }, { - "$ref": "#/parameters/LeaseIdOptional" + "name": "retainUncommittedData", + "in": "query", + "description": "Valid only for flush operations. If \"true\", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/ProposedLeaseIdOptional" + "name": "close", + "in": "query", + "description": "Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is \"flush\" and change notifications are enabled. If the value of close is \"true\" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If \"false\" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/IfMatch" + "name": "Content-Length", + "in": "header", + "description": "Required for \"Append Data\" and \"Flush Data\". Must be 0 for \"Flush Data\". Must be the length of the request content in bytes for \"Append Data\".", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "contentLength" }, { - "$ref": "#/parameters/IfNoneMatch" + "name": "x-ms-content-md5", + "in": "header", + "description": "Specify the transactional md5 for the body, to be validated by the service.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "contentMD5" }, { - "$ref": "#/parameters/IfModifiedSince" + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" }, { - "$ref": "#/parameters/IfUnmodifiedSince" - } - ], - "responses": { - "200": { - "description": "The \"renew\", \"change\" or \"release\" action was successful.", - "headers": { - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string", - "format": "date-time-rfc1123" - }, - "ETag": { - "description": "An HTTP entity tag associated with the file.", - "type": "string" - }, - "Last-Modified": { - "description": "The data and time the file was last modified. Write operations on the file update the last modified time.", - "format": "date-time-rfc1123", - "type": "string" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-lease-id": { - "x-ms-client-name": "LeaseId", - "description": "A successful \"renew\" action returns the lease ID.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - } - } + "name": "x-ms-lease-action", + "in": "header", + "description": "Optional. If \"acquire\" it will acquire the lease. If \"auto-renew\" it will renew the lease. If \"release\" it will release the lease only on flush. If \"acquire-release\" it will acquire & complete the operation & release the lease once operation is done.", + "required": false, + "type": "string", + "enum": [ + "acquire", + "auto-renew", + "release", + "acquire-release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false, + "values": [ + { + "name": "acquire", + "value": "acquire", + "description": "Acquire a lease." + }, + { + "name": "auto-renew", + "value": "auto-renew", + "description": "Auto-renew the lease." + }, + { + "name": "release", + "value": "release", + "description": "Release the lease only on flush." + }, + { + "name": "acquire-release", + "value": "acquire-release", + "description": "Acquire, complete the operation, and release the lease." + } + ] + }, + "x-ms-client-name": "leaseAction" }, - "201": { - "description": "A new lease has been created. The \"acquire\" action was successful.", - "headers": { - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string", - "format": "date-time-rfc1123" - }, - "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", - "type": "string" - }, - "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", - "format": "date-time-rfc1123", - "type": "string" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-lease-id": { - "x-ms-client-name": "LeaseId", - "description": "A successful \"acquire\" action returns the lease ID.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - } - } + { + "name": "x-ms-lease-duration", + "in": "header", + "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "leaseDuration" }, - "202": { - "description": "The \"break\" lease action was successful.", - "headers": { - "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", - "type": "string" - }, - "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", - "format": "date-time-rfc1123", - "type": "string" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-lease-time": { - "x-ms-client-name": "LeaseTime", - "description": "The time remaining in the lease period in seconds.", - "type": "string" - } - } + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "description": "Proposed lease ID, in a GUID string format.", + "required": false, + "type": "string", + "x-ms-client-name": "proposedLeaseId" }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "get": { - "operationId": "Path_Read", - "summary": "Read File", - "description": "Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "tags": [ - "File and Directory Operations" - ], - "parameters": [ { + "name": "x-ms-cache-control", "in": "header", - "description": "The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.", + "description": "Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request.", + "required": false, + "type": "string", + "x-ms-client-name": "cacheControl" + }, + { + "name": "x-ms-content-type", + "in": "header", + "description": "Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request.", "required": false, "type": "string", - "name": "Range" + "x-ms-client-name": "contentType" }, { - "$ref": "#/parameters/LeaseIdOptional" + "name": "x-ms-content-disposition", + "in": "header", + "description": "Optional. Sets the blob's Content-Disposition header.", + "required": false, + "type": "string", + "x-ms-client-name": "contentDisposition" }, { - "name": "x-ms-range-get-content-md5", + "name": "x-ms-content-encoding", "in": "header", - "description": "Optional. 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 4MB in size. If this header is specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).", + "description": "Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request.", "required": false, - "type": "boolean" + "type": "string", + "x-ms-client-name": "contentEncoding" + }, + { + "name": "x-ms-content-language", + "in": "header", + "description": "Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request.", + "required": false, + "type": "string", + "x-ms-client-name": "contentLanguage" + }, + { + "name": "If-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs with a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { - "$ref": "#/parameters/IfMatch" + "name": "If-None-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs without a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { - "$ref": "#/parameters/IfNoneMatch" + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" }, { - "$ref": "#/parameters/IfModifiedSince" + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" }, { - "$ref": "#/parameters/IfUnmodifiedSince" + "name": "x-ms-encryption-key", + "in": "header", + "description": "Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key.", + "required": false, + "type": "string", + "x-ms-client-name": "encryptionKey" }, { - "$ref": "#/parameters/EncryptionKey" + "name": "x-ms-encryption-key-sha256", + "in": "header", + "description": "The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided.", + "required": false, + "type": "string", + "x-ms-client-name": "encryptionKeySha256" }, { - "$ref": "#/parameters/EncryptionKeySha256" + "name": "x-ms-encryption-algorithm", + "in": "header", + "description": "The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided.", + "required": false, + "type": "string", + "enum": [ + "AES256" + ], + "x-ms-enum": { + "name": "EncryptionAlgorithmType", + "modelAsString": false, + "values": [ + { + "name": "AES256", + "value": "AES256", + "description": "The AES256 encryption algorithm." + } + ] + }, + "x-ms-client-name": "encryptionAlgorithm" }, { - "$ref": "#/parameters/EncryptionAlgorithm" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { "200": { - "description": "Ok", + "description": "The request has succeeded.", "headers": { - "Accept-Ranges": { - "description": "Indicates that the service supports requests for partial file content.", - "type": "string" - }, - "Cache-Control": { - "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Disposition": { - "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Encoding": { - "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Language": { - "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, "Content-Length": { - "description": "The size of the resource in bytes.", "type": "integer", - "format": "int64" - }, - "Content-Range": { - "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", - "type": "string" - }, - "Content-Type": { - "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", - "type": "string" - }, - "Content-MD5": { - "description": "The MD5 hash of complete file. If the file has an MD5 hash and this read operation is to read the complete file, this response header is returned so that the client can check for message content integrity.", - "type": "string" + "format": "int64", + "description": "The size of the resource in bytes." }, "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", - "type": "string" + "type": "string", + "description": "An HTTP entity tag associated with the resource." }, "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", - "format": "date-time-rfc1123", - "type": "string" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-resource-type": { - "x-ms-client-name": "ResourceType", - "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", - "type": "string" - }, - "x-ms-properties": { - "x-ms-client-name": "Properties", - "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "type": "string" - }, - "x-ms-lease-duration": { - "x-ms-client-name": "LeaseDuration", - "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", - "type": "string" - }, - "x-ms-lease-state": { - "x-ms-client-name": "LeaseState", - "description": "Lease state of the resource.", - "type": "string" - }, - "x-ms-lease-status": { - "x-ms-client-name": "LeaseStatus", - "description": "The lease status of the resource.", - "type": "string" + "type": "string", + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, "x-ms-encryption-key-sha256": { - "x-ms-client-name": "EncryptionKeySha256", "type": "string", "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." - } - }, - "schema": { - "type": "object", - "format": "file" - } - }, - "206": { - "description": "Partial content", - "headers": { - "Accept-Ranges": { - "description": "Indicates that the service supports requests for partial file content.", - "type": "string" - }, - "Cache-Control": { - "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Disposition": { - "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Encoding": { - "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", - "type": "string" }, - "Content-Language": { - "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Length": { - "description": "The size of the resource in bytes.", - "type": "integer", - "format": "int64" - }, - "Content-Range": { - "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", - "type": "string" - }, - "Content-Type": { - "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", - "type": "string" - }, - "Content-MD5": { - "description": "The MD5 hash of read range. If the request is to read a specified range and the \"x-ms-range-get-content-md5\" is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB.", - "type": "string" - }, - "x-ms-content-md5": { - "description": "The MD5 hash of complete file stored in storage. If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the complete file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range.", - "type": "string" - }, - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string", - "format": "date-time-rfc1123" - }, - "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", - "type": "string" - }, - "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", - "format": "date-time-rfc1123", - "type": "string" + "x-ms-lease-renewed": { + "type": "boolean", + "description": "If the lease was auto-renewed with this request." }, "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-resource-type": { - "x-ms-client-name": "ResourceType", - "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", - "type": "string" - }, - "x-ms-properties": { - "x-ms-client-name": "Properties", - "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "type": "string" - }, - "x-ms-lease-duration": { - "x-ms-client-name": "LeaseDuration", - "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", - "type": "string" - }, - "x-ms-lease-state": { - "x-ms-client-name": "LeaseState", - "description": "Lease state of the resource. ", - "type": "string" - }, - "x-ms-lease-status": { - "x-ms-client-name": "LeaseStatus", - "description": "The lease status of the resource.", - "type": "string" + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", "type": "boolean", "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." }, - "x-ms-encryption-key-sha256": { - "x-ms-client-name": "EncryptionKeySha256", + "x-ms-version": { "type": "string", - "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + "description": "Specifies the version of the operation to use for this request." } - }, - "schema": { - "type": "object", - "format": "file" } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, - "head": { - "operationId": "Path_GetProperties", - "summary": "Get Properties | Get Status | Get Access Control List", - "description": "Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "tags": [ - "File and Directory Operations" + } + }, + "?action=setAccessControl": { + "patch": { + "operationId": "Path_SetAccessControl", + "description": "Set the owner, group, permissions, or access control list for a path.", + "produces": [ + "application/json" ], "parameters": [ { - "name": "action", - "in": "query", - "description": "Optional. If the value is \"getStatus\" only the system defined properties for the path are returned. If the value is \"getAccessControl\" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned.", + "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": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", "required": false, "type": "string", - "enum": [ - "getAccessControl", - "getStatus" - ], - "x-ms-enum": { - "name": "PathGetPropertiesAction", - "modelAsString": false - } + "x-ms-client-name": "clientRequestId" }, { - "$ref": "#/parameters/Upn" + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" }, { - "$ref": "#/parameters/LeaseIdOptional" + "name": "x-ms-owner", + "in": "header", + "description": "Optional. The owner of the blob or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "owner" }, { - "$ref": "#/parameters/IfMatch" + "name": "x-ms-group", + "in": "header", + "description": "Optional. The owning group of the blob or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "group" }, { - "$ref": "#/parameters/IfNoneMatch" + "name": "x-ms-permissions", + "in": "header", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", + "required": false, + "type": "string", + "x-ms-client-name": "permissions" }, { - "$ref": "#/parameters/IfModifiedSince" + "name": "x-ms-acl", + "in": "header", + "description": "Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\".", + "required": false, + "type": "string", + "x-ms-client-name": "acl" }, { - "$ref": "#/parameters/IfUnmodifiedSince" - } - ], - "responses": { - "200": { - "description": "Returns all properties for the file or directory.", - "headers": { - "Accept-Ranges": { - "description": "Indicates that the service supports requests for partial file content.", - "type": "string" - }, - "Cache-Control": { - "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Disposition": { - "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Encoding": { - "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Language": { - "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Length": { - "description": "The size of the resource in bytes.", - "type": "integer", - "format": "int64" - }, - "Content-Range": { - "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", - "type": "string" - }, - "Content-Type": { - "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", - "type": "string" - }, - "Content-MD5": { - "description": "The MD5 hash of complete file stored in storage. This header is returned only for \"GetProperties\" operation. If the Content-MD5 header has been set for the file, this response header is returned for GetProperties call so that the client can check for message content integrity.", - "type": "string" - }, + "name": "If-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs with a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs without a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", - "type": "string" - }, - "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", - "format": "date-time-rfc1123", - "type": "string" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-resource-type": { - "x-ms-client-name": "ResourceType", - "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", - "type": "string" - }, - "x-ms-properties": { - "x-ms-client-name": "Properties", - "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "type": "string" - }, - "x-ms-owner": { - "x-ms-client-name": "Owner", - "description": "The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", - "type": "string" - }, - "x-ms-group": { - "x-ms-client-name": "Group", - "description": "The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", - "type": "string" - }, - "x-ms-permissions": { - "x-ms-client-name": "Permissions", - "description": "The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.", - "type": "string" - }, - "x-ms-acl": { - "x-ms-client-name": "ACL", - "description": "The POSIX access control list for the file or directory. Included in the response only if the action is \"getAccessControl\" and Hierarchical Namespace is enabled for the account.", - "type": "string" - }, - "x-ms-lease-duration": { - "x-ms-client-name": "LeaseDuration", - "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", - "type": "string" - }, - "x-ms-lease-state": { - "x-ms-client-name": "LeaseState", - "description": "Lease state of the resource.", - "type": "string" - }, - "x-ms-lease-status": { - "x-ms-client-name": "LeaseStatus", - "description": "The lease status of the resource.", - "type": "string" - }, - "x-ms-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false." - }, - "x-ms-encryption-key-sha256": { - "x-ms-client-name": "EncryptionKeySha256", "type": "string", - "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + "description": "An HTTP entity tag associated with the resource." }, - "x-ms-encryption-context": { - "x-ms-client-name": "EncryptionContext", + "Last-Modified": { "type": "string", - "description": "The encryption context used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." }, - "x-ms-encryption-scope": { - "x-ms-client-name": "EncryptionScope", + "x-ms-client-request-id": { "type": "string", - "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, - "x-ms-creation-time": { - "x-ms-client-name": "CreationTime", + "x-ms-request-id": { "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the blob was created." + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, - "x-ms-expiry-time": { - "x-ms-client-name": "ExpiresOn", + "x-ms-version": { "type": "string", - "format": "date-time-rfc1123", - "description": "The time this blob will expire." + "description": "Specifies the version of the operation to use for this request." } } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, - "delete": { - "operationId": "Path_Delete", - "summary": "Delete File | Delete Directory", - "description": "Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "tags": [ - "File and Directory Operations" + } + }, + "?action=setAccessControlRecursive": { + "patch": { + "operationId": "Path_SetAccessControlRecursive", + "description": "Set the access control list for a path and sub-paths.", + "produces": [ + "application/json" ], "parameters": [ { - "$ref": "#/parameters/RecursiveOptional" + "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" }, { - "$ref": "#/parameters/Continuation" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "$ref": "#/parameters/LeaseIdOptional" + "name": "mode", + "in": "query", + "description": "Mode \"set\" sets POSIX access control rights on files and directories, \"modify\" modifies one or more POSIX access control rights that pre-exist on files and directories, \"remove\" removes one or more POSIX access control rights that were present earlier on files and directories.", + "required": true, + "type": "string", + "enum": [ + "set", + "modify", + "remove" + ], + "x-ms-enum": { + "name": "PathSetAccessControlRecursiveMode", + "modelAsString": false, + "values": [ + { + "name": "set", + "value": "set", + "description": "Set POSIX access control rights." + }, + { + "name": "modify", + "value": "modify", + "description": "Modify POSIX access control rights." + }, + { + "name": "remove", + "value": "remove", + "description": "Remove POSIX access control rights." + } + ] + } }, { - "$ref": "#/parameters/IfMatch" + "name": "continuation", + "in": "query", + "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/IfNoneMatch" + "name": "forceFlag", + "in": "query", + "description": "Optional. Valid for \"SetAccessControlRecursive\" operation. If set to false, the operation will terminate quickly on encountering user errors (4XX). If true, the operation will ignore user errors and proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag is true in case of user errors. If not set the default value is false for this.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/IfModifiedSince" + "name": "maxRecords", + "in": "query", + "description": "Optional. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or greater than 2,000, the request will process up to 2,000 items.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 }, { - "$ref": "#/parameters/IfUnmodifiedSince" + "name": "x-ms-acl", + "in": "header", + "description": "Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\".", + "required": false, + "type": "string", + "x-ms-client-name": "acl" }, { - "$ref": "#/parameters/Paginated" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { "200": { - "description": "The file was deleted.", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SetAccessControlRecursiveResponse" + }, "headers": { "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, "x-ms-continuation": { - "x-ms-client-name": "Continuation", - "description": "When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", - "type": "string" - }, - "x-ms-deletion-id": { - "x-ms-client-name": "DeletionId", - "description": "Returned only for hierarchical namespace space enabled accounts when soft delete is enabled. A unique identifier for the entity that can be used to restore it. See the Undelete REST API for more information.", - "type": "string" - } - } - }, - "202": { - "description": "Delete request is accepted, applicable only when Hierarchical Namespace is enabled for the account.", - "headers": { - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths." }, "x-ms-request-id": { - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, "x-ms-version": { - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-continuation": { - "description": "Applicable only when Hierarchical Namespace is enabled for the account. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response when the following conditions are met: Delete should be on a directory with query parameters \"recursive\" and \"paginated\" set to true, the identity of the user calling the api should be a non-super user using ACL based authorization, number of paths to be deleted exceeds a limit, request version is 2023-08-03 and later. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. Directory is successfully deleted when the continuation token returned is empty. The actual directory deletion happens only in the last invocation, the previous ones involve ACL checks in the server of the files and directories under the directory to be recursively deleted.", - "type": "string" + "type": "string", + "description": "Specifies the version of the operation to use for this request." } } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "$ref": "#/parameters/Path" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ] + } }, - "/{filesystem}/{path}?action=setAccessControl": { - "patch": { - "tags": [ - "directory" + "?comp=expiry": { + "put": { + "operationId": "Path_SetExpiry", + "description": "Sets the time a blob will expire and be deleted.", + "produces": [ + "application/json" ], - "operationId": "Path_SetAccessControl", - "description": "Set the owner, group, permissions, or access control list for a path.", "parameters": [ { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/Owner" - }, - { - "$ref": "#/parameters/Group" - }, - { - "$ref": "#/parameters/Permissions" - }, - { - "$ref": "#/parameters/Acl" - }, - { - "$ref": "#/parameters/IfMatch" - }, - { - "$ref": "#/parameters/IfNoneMatch" + "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" }, { - "$ref": "#/parameters/IfModifiedSince" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "$ref": "#/parameters/IfUnmodifiedSince" + "name": "x-ms-expiry-option", + "in": "header", + "description": "Required. Indicates mode of the expiry time.", + "required": true, + "type": "string", + "enum": [ + "NeverExpire", + "RelativeToCreation", + "RelativeToNow", + "Absolute" + ], + "x-ms-enum": { + "name": "PathExpiryOptions", + "modelAsString": true, + "values": [ + { + "name": "NeverExpire", + "value": "NeverExpire", + "description": "Never expire." + }, + { + "name": "RelativeToCreation", + "value": "RelativeToCreation", + "description": "Relative to creation time." + }, + { + "name": "RelativeToNow", + "value": "RelativeToNow", + "description": "Relative to now." + }, + { + "name": "Absolute", + "value": "Absolute", + "description": "Absolute time." + } + ] + }, + "x-ms-client-name": "expiryOptions" }, { - "$ref": "#/parameters/ClientRequestId" + "name": "x-ms-expiry-time", + "in": "header", + "description": "The time to set the blob to expiry.", + "required": false, + "type": "string", + "x-ms-client-name": "expiresOn" }, { - "$ref": "#/parameters/ApiVersionParameter" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { "200": { - "description": "Set directory access control response.", + "description": "The request has succeeded.", "headers": { "Date": { "type": "string", - "format": "date-time-rfc1123", + "format": "date-time-rfc7231", "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { "type": "string", - "description": "An HTTP entity tag associated with the file or directory." + "description": "An HTTP entity tag associated with the resource." }, "Last-Modified": { "type": "string", - "format": "date-time-rfc1123", - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." }, "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, "x-ms-request-id": { - "x-ms-client-name": "RequestId", "type": "string", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, "x-ms-version": { - "x-ms-client-name": "Version", "type": "string", - "description": "The version of the REST protocol used to process the request." + "description": "Specifies the version of the operation to use for this request." } } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", + "x-ms-error-code": { "type": "string", - "description": "The version of the REST protocol used to process the request." + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "$ref": "#/parameters/Path" - }, - { - "name": "action", - "description": "action", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "setAccessControl" - ] - } - ] + } }, - "/{filesystem}/{path}?action=setAccessControlRecursive": { - "patch": { - "tags": [ - "directory" + "?comp=undelete": { + "put": { + "operationId": "Path_Undelete", + "description": "Undelete a path that was previously soft deleted.", + "produces": [ + "application/json" ], - "operationId": "Path_SetAccessControlRecursive", - "description": "Set the access control list for a path and sub-paths.", "parameters": [ { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Continuation" + "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" }, { - "$ref": "#/parameters/PathSetAccessControlRecursiveMode" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "$ref": "#/parameters/ForceFlag" + "name": "x-ms-undelete-source", + "in": "header", + "description": "Only for hierarchical namespace enabled accounts. Optional. The path of the soft deleted blob to undelete.", + "required": false, + "type": "string", + "x-ms-client-name": "undeleteSource" }, { - "name": "maxRecords", + "name": "timeout", "in": "query", - "description": "Optional. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or greater than 2,000, the request will process up to 2,000 items", - "format": "int32", - "minimum": 1, + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", "required": false, - "type": "integer" - }, - { - "$ref": "#/parameters/Acl" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ApiVersionParameter" + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { "200": { - "description": "Set directory access control recursive response.", + "description": "The request has succeeded.", "headers": { "Date": { "type": "string", - "format": "date-time-rfc1123", + "format": "date-time-rfc7231", "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-continuation": { - "x-ms-client-name": "Continuation", - "description": "When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory.", - "type": "string" + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, "x-ms-request-id": { - "x-ms-client-name": "RequestId", "type": "string", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, + "x-ms-resource-type": { + "type": "string", + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\"." + }, "x-ms-version": { - "x-ms-client-name": "Version", "type": "string", - "description": "The version of the REST protocol used to process the request." + "description": "Specifies the version of the operation to use for this request." } - }, - "schema": { - "$ref": "#/definitions/SetAccessControlRecursiveResponse" } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", + "x-ms-error-code": { "type": "string", - "description": "The version of the REST protocol used to process the request." + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "$ref": "#/parameters/Path" - }, - { - "name": "action", - "description": "action", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "setAccessControlRecursive" - ] - } - ] + } }, - "/{filesystem}/{path}?action=flush": { - "patch": { - "tags": [ - "directory" + "?resource=filesystem": { + "get": { + "operationId": "FileSystem_ListPaths", + "description": "List FileSystem paths and their properties.", + "produces": [ + "application/json" ], - "operationId": "Path_FlushData", - "description": "Set the owner, group, permissions, or access control list for a path.", "parameters": [ { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/Position" - }, - { - "$ref": "#/parameters/RetainUncommittedData" - }, - { - "$ref": "#/parameters/Close" - }, - { - "$ref": "#/parameters/ContentLength" - }, - { - "$ref": "#/parameters/ContentMD5" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/LeaseAction" - }, - { - "$ref": "#/parameters/LeaseDurationMethod" - }, - { - "$ref": "#/parameters/ProposedLeaseIdOptional" - }, - { - "$ref": "#/parameters/CacheControl" - }, - { - "$ref": "#/parameters/ContentType" - }, - { - "$ref": "#/parameters/ContentDisposition" - }, - { - "$ref": "#/parameters/ContentEncoding" - }, - { - "$ref": "#/parameters/ContentLanguage" - }, - { - "$ref": "#/parameters/IfMatch" + "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" }, { - "$ref": "#/parameters/IfNoneMatch" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "$ref": "#/parameters/IfModifiedSince" + "name": "continuation", + "in": "query", + "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/IfUnmodifiedSince" + "name": "directory", + "in": "query", + "description": "Optional. Filters results to paths within the specified directory. An error occurs if the directory does not exist.", + "required": false, + "type": "string", + "x-ms-client-name": "path" }, { - "$ref": "#/parameters/ClientRequestId" + "name": "recursive", + "in": "query", + "description": "Required", + "required": true, + "type": "boolean" }, { - "$ref": "#/parameters/ApiVersionParameter" + "name": "maxResults", + "in": "query", + "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 }, { - "$ref": "#/parameters/EncryptionKey" + "name": "upn", + "in": "query", + "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/EncryptionKeySha256" + "name": "beginFrom", + "in": "query", + "description": "Optional. A relative path within the specified directory where the listing will start from.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/EncryptionAlgorithm" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { "200": { - "description": "The data was flushed (written) to the file successfully.", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PathList" + }, "headers": { "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", "type": "string", - "format": "date-time-rfc1123" + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", - "type": "string" + "type": "string", + "description": "An HTTP entity tag associated with the resource." }, "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", - "format": "date-time-rfc1123", - "type": "string" - }, - "Content-Length": { - "description": "The size of the resource in bytes.", - "type": "integer", - "format": "int64" - }, - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "description": "The version of the REST protocol used to process the request.", - "type": "string" + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." - }, - "x-ms-encryption-key-sha256": { - "x-ms-client-name": "EncryptionKeySha256", + "x-ms-client-request-id": { "type": "string", - "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, - "x-ms-lease-renewed": { - "x-ms-client-name": "LeaseRenewed", - "type": "boolean", - "description": "If the lease was auto-renewed with this request" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", + "x-ms-continuation": { "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths." }, "x-ms-request-id": { - "x-ms-client-name": "RequestId", "type": "string", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, "x-ms-version": { - "x-ms-client-name": "Version", "type": "string", - "description": "The version of the REST protocol used to process the request." + "description": "Specifies the version of the operation to use for this request." } - }, + } + }, + "default": { + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/StorageError" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } } } } - }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "$ref": "#/parameters/Path" - }, - { - "name": "action", - "description": "action", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "flush" - ] - } - ] + } }, - "/{filesystem}/{path}?action=append": { - "patch": { - "tags": [ - "directory" - ], - "operationId": "Path_AppendData", - "description": "Append data to the file.", + "?restype=container&comp=list": { + "get": { + "operationId": "FileSystem_ListBlobHierarchySegment", + "description": "The List Blobs operation returns a list of the blobs under the specified container.", "parameters": [ { - "$ref": "#/parameters/Position" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ContentLength" - }, - { - "$ref": "#/parameters/TransactionalContentMD5" - }, - { - "$ref": "#/parameters/ContentCrc64" - }, - { - "$ref": "#/parameters/LeaseIdOptional" - }, - { - "$ref": "#/parameters/LeaseAction" - }, - { - "$ref": "#/parameters/LeaseDurationMethod" - }, - { - "$ref": "#/parameters/ProposedLeaseIdOptional" - }, - { - "$ref": "#/parameters/Body" + "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" }, { - "$ref": "#/parameters/ClientRequestId" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "$ref": "#/parameters/ApiVersionParameter" + "name": "prefix", + "in": "query", + "description": "Filters results to filesystems within the specified prefix.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/EncryptionKey" + "name": "delimiter", + "in": "query", + "description": "When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/EncryptionKeySha256" + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/EncryptionAlgorithm" + "name": "maxResults", + "in": "query", + "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 }, { - "$ref": "#/parameters/Flush" + "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": [ + "copy", + "deleted", + "metadata", + "snapshots", + "uncommittedblobs", + "versions", + "tags" + ], + "x-ms-enum": { + "name": "ListBlobsIncludeItem", + "modelAsString": false, + "values": [ + { + "name": "copy", + "value": "copy", + "description": "Include copy information." + }, + { + "name": "deleted", + "value": "deleted", + "description": "Include deleted blobs." + }, + { + "name": "metadata", + "value": "metadata", + "description": "Include metadata." + }, + { + "name": "snapshots", + "value": "snapshots", + "description": "Include snapshots." + }, + { + "name": "uncommittedblobs", + "value": "uncommittedblobs", + "description": "Include uncommitted blobs." + }, + { + "name": "versions", + "value": "versions", + "description": "Include versions." + }, + { + "name": "tags", + "value": "tags", + "description": "Include tags." + } + ] + } + }, + "collectionFormat": "csv" }, { - "$ref": "#/parameters/StructuredBodyPut" + "name": "showonly", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "string", + "enum": [ + "deleted" + ], + "x-ms-enum": { + "name": "ListBlobsShowOnly", + "modelAsString": false, + "values": [ + { + "name": "deleted", + "value": "deleted", + "description": "Show only deleted blobs." + } + ] + } }, { - "$ref": "#/parameters/StructuredContentLength" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { - "202": { - "description": "Append data to file control response.", + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListBlobsHierarchySegmentResponse" + }, "headers": { "Date": { "type": "string", - "format": "date-time-rfc1123", + "format": "date-time-rfc7231", "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "The version of the REST protocol used to process the request." - }, - "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", - "type": "string" - }, - "Content-MD5": { - "type": "string", - "format": "byte", - "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." - }, - "x-ms-content-crc64": { "type": "string", - "format": "byte", - "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." - }, - "x-ms-request-server-encrypted": { - "x-ms-client-name": "IsServerEncrypted", - "type": "boolean", - "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, - "x-ms-encryption-key-sha256": { - "x-ms-client-name": "EncryptionKeySha256", + "x-ms-request-id": { "type": "string", - "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." - }, - "x-ms-lease-renewed": { - "x-ms-client-name": "LeaseRenewed", - "type": "boolean", - "description": "If the lease was auto-renewed with this request" + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, - "x-ms-structured-body": { - "x-ms-client-name": "StructuredBodyType", + "x-ms-version": { "type": "string", - "description": "Indicates the structured message body was accepted and mirrors back the message schema version and properties." + "description": "Specifies the version of the operation to use for this request." } } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." - }, - "x-ms-version": { - "x-ms-client-name": "Version", + "x-ms-error-code": { "type": "string", - "description": "The version of the REST protocol used to process the request." + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "$ref": "#/parameters/Path" - }, - { - "name": "action", - "description": "action", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "append" - ] - } - ] + } }, - "/{filesystem}/{path}?comp=expiry": { + "/?_overload=create": { "put": { - "tags": [ - "blob" + "operationId": "Path_Create", + "description": "Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", + "produces": [ + "application/json" ], - "operationId": "Path_SetExpiry", - "description": "Sets the time a blob will expire and be deleted.", "parameters": [ { - "$ref": "#/parameters/Timeout" + "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": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "resource", + "in": "query", + "description": "Required only for Create File and Create Directory. The value must be \"file\" or \"directory\".", + "required": false, + "type": "string", + "enum": [ + "directory", + "file" + ], + "x-ms-enum": { + "name": "PathResourceType", + "modelAsString": false, + "values": [ + { + "name": "directory", + "value": "directory", + "description": "A directory resource type." + }, + { + "name": "file", + "value": "file", + "description": "A file resource type." + } + ] + } + }, + { + "name": "mode", + "in": "query", + "description": "Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be \"legacy\" or \"posix\", and the default value will be \"posix\".", + "required": false, + "type": "string", + "enum": [ + "legacy", + "posix" + ], + "x-ms-enum": { + "name": "PathRenameMode", + "modelAsString": false, + "values": [ + { + "name": "legacy", + "value": "legacy", + "description": "Legacy rename mode." + }, + { + "name": "posix", + "value": "posix", + "description": "POSIX rename mode." + } + ] + } + }, + { + "name": "continuation", + "in": "query", + "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-cache-control", + "in": "header", + "description": "Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request.", + "required": false, + "type": "string", + "x-ms-client-name": "cacheControl" + }, + { + "name": "x-ms-content-encoding", + "in": "header", + "description": "Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request.", + "required": false, + "type": "string", + "x-ms-client-name": "contentEncoding" + }, + { + "name": "x-ms-content-language", + "in": "header", + "description": "Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request.", + "required": false, + "type": "string", + "x-ms-client-name": "contentLanguage" + }, + { + "name": "x-ms-content-disposition", + "in": "header", + "description": "Optional. Sets the blob's Content-Disposition header.", + "required": false, + "type": "string", + "x-ms-client-name": "contentDisposition" + }, + { + "name": "x-ms-content-type", + "in": "header", + "description": "Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request.", + "required": false, + "type": "string", + "x-ms-client-name": "contentType" + }, + { + "name": "x-ms-rename-source", + "in": "header", + "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", + "required": false, + "type": "string", + "x-ms-client-name": "renameSource" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-source-lease-id", + "in": "header", + "description": "A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match.", + "required": false, + "type": "string", + "x-ms-client-name": "sourceLeaseId" + }, + { + "name": "x-ms-properties", + "in": "header", + "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "required": false, + "type": "string", + "x-ms-client-name": "properties" + }, + { + "name": "x-ms-permissions", + "in": "header", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", + "required": false, + "type": "string", + "x-ms-client-name": "permissions" + }, + { + "name": "x-ms-umask", + "in": "header", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p bitwise and not u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).", + "required": false, + "type": "string", + "x-ms-client-name": "umask" + }, + { + "name": "If-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs with a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs without a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "x-ms-source-if-match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs with a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "sourceIfMatch" + }, + { + "name": "x-ms-source-if-none-match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs without a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "sourceIfNoneMatch" + }, + { + "name": "x-ms-source-if-modified-since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "sourceIfModifiedSince" + }, + { + "name": "x-ms-source-if-unmodified-since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "sourceIfUnmodifiedSince" + }, + { + "name": "x-ms-encryption-key", + "in": "header", + "description": "Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key.", + "required": false, + "type": "string", + "x-ms-client-name": "encryptionKey" + }, + { + "name": "x-ms-encryption-key-sha256", + "in": "header", + "description": "The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided.", + "required": false, + "type": "string", + "x-ms-client-name": "encryptionKeySha256" + }, + { + "name": "x-ms-encryption-algorithm", + "in": "header", + "description": "The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided.", + "required": false, + "type": "string", + "enum": [ + "AES256" + ], + "x-ms-enum": { + "name": "EncryptionAlgorithmType", + "modelAsString": false, + "values": [ + { + "name": "AES256", + "value": "AES256", + "description": "The AES256 encryption algorithm." + } + ] + }, + "x-ms-client-name": "encryptionAlgorithm" + }, + { + "name": "x-ms-owner", + "in": "header", + "description": "Optional. The owner of the blob or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "owner" + }, + { + "name": "x-ms-group", + "in": "header", + "description": "Optional. The owning group of the blob or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "group" + }, + { + "name": "x-ms-acl", + "in": "header", + "description": "Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\".", + "required": false, + "type": "string", + "x-ms-client-name": "acl" + }, + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "description": "Proposed lease ID, in a GUID string format.", + "required": false, + "type": "string", + "x-ms-client-name": "proposedLeaseId" + }, + { + "name": "x-ms-lease-duration", + "in": "header", + "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "leaseDuration" }, { - "$ref": "#/parameters/ApiVersionParameter" + "name": "x-ms-expiry-option", + "in": "header", + "description": "Required. Indicates mode of the expiry time.", + "required": false, + "type": "string", + "enum": [ + "NeverExpire", + "RelativeToCreation", + "RelativeToNow", + "Absolute" + ], + "x-ms-enum": { + "name": "PathExpiryOptions", + "modelAsString": true, + "values": [ + { + "name": "NeverExpire", + "value": "NeverExpire", + "description": "Never expire." + }, + { + "name": "RelativeToCreation", + "value": "RelativeToCreation", + "description": "Relative to creation time." + }, + { + "name": "RelativeToNow", + "value": "RelativeToNow", + "description": "Relative to now." + }, + { + "name": "Absolute", + "value": "Absolute", + "description": "Absolute time." + } + ] + }, + "x-ms-client-name": "expiryOptions" }, { - "$ref": "#/parameters/ClientRequestId" + "name": "x-ms-expiry-time", + "in": "header", + "description": "The time to set the blob to expiry.", + "required": false, + "type": "string", + "x-ms-client-name": "expiresOn" }, { - "$ref": "#/parameters/PathExpiryOptions" + "name": "x-ms-encryption-context", + "in": "header", + "description": "Specifies the encryption context to set on the file.", + "required": false, + "type": "string", + "x-ms-client-name": "encryptionContext" }, { - "$ref": "#/parameters/PathExpiryTime" + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { - "200": { - "description": "The blob expiry was set successfully.", + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", "headers": { + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The size of the resource in bytes." + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, "ETag": { "type": "string", - "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + "description": "An HTTP entity tag associated with the resource." }, "Last-Modified": { "type": "string", - "format": "date-time-rfc1123", - "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." }, "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", + "x-ms-continuation": { "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths." }, - "x-ms-version": { - "x-ms-client-name": "Version", + "x-ms-encryption-key-sha256": { "type": "string", - "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." }, - "Date": { + "x-ms-request-id": { + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "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 using the specified algorithm, and false otherwise." + }, + "x-ms-version": { "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." + "description": "Specifies the version of the operation to use for this request." } } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "$ref": "#/parameters/Path" - }, - { - "name": "comp", - "description": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "expiry" - ] - } - ] + } }, - "/{filesystem}/{path}?comp=undelete": { - "put": { - "tags": [ - "blob" + "/?_overload=delete": { + "delete": { + "operationId": "Path_Delete", + "description": "Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "produces": [ + "application/json" ], - "operationId": "Path_Undelete", - "description": "Undelete a path that was previously soft deleted", "parameters": [ { - "$ref": "#/parameters/Timeout" + "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" }, { - "$ref": "#/parameters/UndeleteSource" + "name": "x-ms-client-request-id", + "in": "header", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" }, { - "$ref": "#/parameters/ApiVersionParameter" + "name": "recursive", + "in": "query", + "description": "Required", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/ClientRequestId" - } + "name": "continuation", + "in": "query", + "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "If-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs with a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs without a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "paginated", + "in": "query", + "description": "If true, paginated behavior will be seen. Pagination is for the recursive ACL checks as a POSIX requirement in the server and Delete in an atomic operation once the ACL checks are completed. If false or missing, normal default behavior will kick in, which may timeout in case of very large directories due to recursive ACL checks. This new parameter is introduced for backward compatibility.", + "required": false, + "type": "boolean" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "x-ms-continuation": { + "type": "string", + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths." + }, + "x-ms-deletion-id": { + "type": "string", + "description": "Returned only for hierarchical namespace space enabled accounts when soft delete is enabled. A unique identifier for the entity that can be used to restore it." + }, + "x-ms-request-id": { + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "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/StorageError" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "/?_overload=getProperties": { + "head": { + "operationId": "Path_GetProperties", + "description": "Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "produces": [ + "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": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "action", + "in": "query", + "description": "Optional. If the value is \"getStatus\" only the system defined properties for the path are returned. If the value is \"getAccessControl\" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned.", + "required": false, + "type": "string", + "enum": [ + "getAccessControl", + "getStatus" + ], + "x-ms-enum": { + "name": "PathGetPropertiesAction", + "modelAsString": false, + "values": [ + { + "name": "getAccessControl", + "value": "getAccessControl", + "description": "Get access control list." + }, + { + "name": "getStatus", + "value": "getStatus", + "description": "Get status." + } + ] + } + }, + { + "name": "upn", + "in": "query", + "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.", + "required": false, + "type": "boolean" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "If-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs with a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs without a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Cache-Control": { + "type": "string", + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Disposition": { + "type": "string", + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Encoding": { + "type": "string", + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Language": { + "type": "string", + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The size of the resource in bytes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "The MD5 hash of the content." + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream." + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "ETag": { + "type": "string", + "description": "An HTTP entity tag associated with the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." + }, + "x-ms-acl": { + "type": "string", + "description": "The POSIX access control list for the file or directory. Included in the response only if the action is \"getAccessControl\" and Hierarchical Namespace is enabled for the account." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "x-ms-creation-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "Returns the date and time the blob was created." + }, + "x-ms-encryption-context": { + "type": "string", + "description": "The encryption context used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-key-sha256": { + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-expiry-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time this blob will expire." + }, + "x-ms-group": { + "type": "string", + "description": "The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account." + }, + "x-ms-lease-duration": { + "type": "string", + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration." + }, + "x-ms-lease-state": { + "type": "string", + "description": "Lease state of the resource." + }, + "x-ms-lease-status": { + "type": "string", + "description": "The lease status of the resource." + }, + "x-ms-owner": { + "type": "string", + "description": "The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account." + }, + "x-ms-permissions": { + "type": "string", + "description": "The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account." + }, + "x-ms-properties": { + "type": "string", + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set." + }, + "x-ms-request-id": { + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-resource-type": { + "type": "string", + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\"." + }, + "x-ms-server-encrypted": { + "type": "boolean", + "description": "The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false." + }, + "x-ms-version": { + "type": "string", + "description": "Specifies the version of the operation to use for this request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "/?_overload=read": { + "get": { + "operationId": "Path_Read", + "description": "Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "produces": [ + "application/octet-stream", + "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": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "Range", + "in": "header", + "description": "The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.", + "required": false, + "type": "string", + "x-ms-client-name": "range" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-range-get-content-md5", + "in": "header", + "description": "Optional. 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 4MB in size.", + "required": false, + "type": "boolean", + "x-ms-client-name": "rangeGetContentMD5" + }, + { + "name": "If-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs with a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs without a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "x-ms-encryption-key", + "in": "header", + "description": "Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key.", + "required": false, + "type": "string", + "x-ms-client-name": "encryptionKey" + }, + { + "name": "x-ms-encryption-key-sha256", + "in": "header", + "description": "The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided.", + "required": false, + "type": "string", + "x-ms-client-name": "encryptionKeySha256" + }, + { + "name": "x-ms-encryption-algorithm", + "in": "header", + "description": "The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided.", + "required": false, + "type": "string", + "enum": [ + "AES256" + ], + "x-ms-enum": { + "name": "EncryptionAlgorithmType", + "modelAsString": false, + "values": [ + { + "name": "AES256", + "value": "AES256", + "description": "The AES256 encryption algorithm." + } + ] + }, + "x-ms-client-name": "encryptionAlgorithm" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + }, + "headers": { + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Cache-Control": { + "type": "string", + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Disposition": { + "type": "string", + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Encoding": { + "type": "string", + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Language": { + "type": "string", + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The size of the resource in bytes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "The MD5 hash of the content." + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header." + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "ETag": { + "type": "string", + "description": "An HTTP entity tag associated with the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." + }, + "x-ms-client-request-id": { + "type": "string", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "x-ms-encryption-key-sha256": { + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-lease-duration": { + "type": "string", + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration." + }, + "x-ms-lease-state": { + "type": "string", + "description": "Lease state of the resource." + }, + "x-ms-lease-status": { + "type": "string", + "description": "The lease status of the resource." + }, + "x-ms-properties": { + "type": "string", + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set." + }, + "x-ms-request-id": { + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "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 using the specified algorithm, and false otherwise." + }, + "x-ms-resource-type": { + "type": "string", + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\"." + }, + "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/StorageError" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "The error code." + } + } + } + } + } + }, + "/?_overload=update": { + "patch": { + "operationId": "Path_Update", + "description": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. Concurrent writes to the same file using multiple clients are not supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://learn.microsoft.com/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "produces": [ + "application/json" + ], + "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": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "action", + "in": "query", + "description": "The action must be \"append\" to upload data to be appended to a file, \"flush\" to flush previously uploaded data to a file, \"setProperties\" to set the properties of a file or directory, \"setAccessControl\" to set the owner, group, permissions, or access control list for a file or directory, or \"setAccessControlRecursive\" to set the access control list for a directory recursively. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.", + "required": true, + "type": "string", + "enum": [ + "append", + "flush", + "setProperties", + "setAccessControl", + "setAccessControlRecursive" + ], + "x-ms-enum": { + "name": "PathUpdateAction", + "modelAsString": false, + "values": [ + { + "name": "append", + "value": "append", + "description": "Append data to the file." + }, + { + "name": "flush", + "value": "flush", + "description": "Flush previously uploaded data to a file." + }, + { + "name": "setProperties", + "value": "setProperties", + "description": "Set the properties of a file or directory." + }, + { + "name": "setAccessControl", + "value": "setAccessControl", + "description": "Set the access control for a file or directory." + }, + { + "name": "setAccessControlRecursive", + "value": "setAccessControlRecursive", + "description": "Set the access control list for a directory recursively." + } + ] + } + }, + { + "name": "maxRecords", + "in": "query", + "description": "Optional. Valid for \"SetAccessControlRecursive\" operation. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or greater than 2,000, the request will process up to 2,000 items.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "continuation", + "in": "query", + "description": "Optional. The number of paths processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be percent-encoded and specified in a subsequent invocation of setAccessControlRecursive operation.", + "required": false, + "type": "string" + }, + { + "name": "mode", + "in": "query", + "description": "Mode for set access control recursive.", + "required": false, + "type": "string", + "enum": [ + "set", + "modify", + "remove" + ], + "x-ms-enum": { + "name": "PathSetAccessControlRecursiveMode", + "modelAsString": false, + "values": [ + { + "name": "set", + "value": "set", + "description": "Set POSIX access control rights." + }, + { + "name": "modify", + "value": "modify", + "description": "Modify POSIX access control rights." + }, + { + "name": "remove", + "value": "remove", + "description": "Remove POSIX access control rights." + } + ] + } + }, + { + "name": "forceFlag", + "in": "query", + "description": "Optional. Valid for \"SetAccessControlRecursive\" operation. If set to false, the operation will terminate quickly on encountering user errors (4XX). If true, the operation will ignore user errors and proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag is true in case of user errors. If not set the default value is false for this.", + "required": false, + "type": "boolean" + }, + { + "name": "position", + "in": "query", + "description": "This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "retainUncommittedData", + "in": "query", + "description": "Valid only for flush operations. If \"true\", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.", + "required": false, + "type": "boolean" + }, + { + "name": "close", + "in": "query", + "description": "Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is \"flush\" and change notifications are enabled. If the value of close is \"true\" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If \"false\" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed.", + "required": false, + "type": "boolean" + }, + { + "name": "Content-Length", + "in": "header", + "description": "Required for \"Append Data\" and \"Flush Data\". Must be 0 for \"Flush Data\". Must be the length of the request content in bytes for \"Append Data\".", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "contentLength" + }, + { + "name": "x-ms-content-md5", + "in": "header", + "description": "Specify the transactional md5 for the body, to be validated by the service.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-client-name": "contentMD5" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID.", + "required": false, + "type": "string", + "x-ms-client-name": "leaseId" + }, + { + "name": "x-ms-cache-control", + "in": "header", + "description": "Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request.", + "required": false, + "type": "string", + "x-ms-client-name": "cacheControl" + }, + { + "name": "x-ms-content-disposition", + "in": "header", + "description": "Optional. Sets the blob's Content-Disposition header.", + "required": false, + "type": "string", + "x-ms-client-name": "contentDisposition" + }, + { + "name": "x-ms-content-encoding", + "in": "header", + "description": "Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request.", + "required": false, + "type": "string", + "x-ms-client-name": "contentEncoding" + }, + { + "name": "x-ms-content-language", + "in": "header", + "description": "Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request.", + "required": false, + "type": "string", + "x-ms-client-name": "contentLanguage" + }, + { + "name": "x-ms-properties", + "in": "header", + "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "required": false, + "type": "string", + "x-ms-client-name": "properties" + }, + { + "name": "x-ms-owner", + "in": "header", + "description": "Optional. The owner of the blob or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "owner" + }, + { + "name": "x-ms-group", + "in": "header", + "description": "Optional. The owning group of the blob or directory.", + "required": false, + "type": "string", + "x-ms-client-name": "group" + }, + { + "name": "x-ms-permissions", + "in": "header", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", + "required": false, + "type": "string", + "x-ms-client-name": "permissions" + }, + { + "name": "x-ms-acl", + "in": "header", + "description": "Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\".", + "required": false, + "type": "string", + "x-ms-client-name": "acl" + }, + { + "name": "If-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs with a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Specify an ETag value to operate only on blobs without a matching value.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "x-ms-structured-body", + "in": "header", + "description": "Required if the request body is a structured message. 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": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "body", + "in": "body", + "description": "Initial data.", + "required": true, + "schema": { + "type": "string", + "format": "binary" + } + } ], "responses": { "200": { - "description": "The blob was undeleted successfully.", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SetAccessControlRecursiveResponse" + }, "headers": { + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Cache-Control": { + "type": "string", + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Disposition": { + "type": "string", + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Encoding": { + "type": "string", + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Language": { + "type": "string", + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The size of the resource in bytes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "The MD5 hash of the content." + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header." + }, + "Date": { + "type": "string", + "format": "date-time-rfc7231", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "ETag": { + "type": "string", + "description": "An HTTP entity tag associated with the resource." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The data and time the resource was last modified." + }, "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", + "x-ms-continuation": { "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths." }, - "x-ms-resource-type": { - "x-ms-client-name": "ResourceType", - "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", - "type": "string" + "x-ms-properties": { + "type": "string", + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set." }, - "x-ms-version": { - "x-ms-client-name": "Version", + "x-ms-request-id": { "type": "string", - "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." }, - "Date": { + "x-ms-version": { "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." + "description": "Specifies the version of the operation to use for this request." } } }, "default": { - "description": "Failure", + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/StorageError" + }, "headers": { "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "type": "string", + "description": "The error code." } - }, - "schema": { - "$ref": "#/definitions/StorageError" } } } - }, - "parameters": [ - { - "$ref": "#/parameters/FileSystem" - }, - { - "$ref": "#/parameters/Path" - }, - { - "name": "comp", - "description": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "undelete" - ] - } - ] + } } }, - "parameters": { - "Url": { - "name": "url", - "description": "The URL of the service account, container, or blob that is the target of the desired operation.", - "required": true, - "x-ms-parameter-location": "client", - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "FileSystemResource": { - "name": "resource", - "in": "query", - "x-ms-parameter-location": "client", - "description": "The value must be \"filesystem\" for all filesystem operations.", - "required": true, + "definitions": { + "AccountResourceType": { "type": "string", + "description": "The value must be \"account\" for all account operations.", "enum": [ - "filesystem" + "account" ], "x-ms-enum": { - "name": "FileSystemResourceType", - "modelAsString": false + "name": "AccountResourceType", + "modelAsString": false, + "values": [ + { + "name": "account", + "value": "account", + "description": "The account resource type." + } + ] } }, - "ApiVersionParameter": { - "name": "x-ms-version", - "x-ms-parameter-location": "client", - "x-ms-client-name": "version", - "in": "header", - "required": true, - "type": "string", - "description": "Specifies the version of the operation to use for this request." - }, - "accountName": { - "description": "The Azure Storage account name.", - "in": "path", - "name": "accountName", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "method" - }, - "dnsSuffix": { - "default": "dfs.core.windows.net", - "description": "The DNS suffix for the Azure Data Lake Storage endpoint.", - "in": "path", - "name": "dnsSuffix", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "method" + "AclFailedEntry": { + "type": "object", + "description": "An ACL failed entry.", + "properties": { + "name": { + "type": "string", + "description": "The name of the entry." + }, + "type": { + "type": "string", + "description": "The type of the entry." + }, + "errorMessage": { + "type": "string", + "description": "The error message." + } + } }, - "ClientRequestId": { - "name": "x-ms-client-request-id", - "x-ms-client-name": "requestId", - "in": "header", - "required": false, + "Azure.Core.eTag": { "type": "string", - "x-ms-parameter-location": "method", - "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." - }, - "Timeout": { - "name": "timeout", - "in": "query", - "required": false, - "type": "integer", - "minimum": 0, - "x-ms-parameter-location": "method", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations." + "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" + } }, - "IfMatch": { - "name": "If-Match", - "x-ms-client-name": "ifMatch", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "modified-access-conditions" + "BlobHierarchyListSegment": { + "type": "object", + "description": "A segment of blob hierarchy items.", + "properties": { + "blobPrefixes": { + "type": "array", + "description": "The blob prefixes.", + "items": { + "$ref": "#/definitions/BlobPrefix" + }, + "xml": { + "name": "BlobPrefix", + "wrapped": false + } + }, + "blobItems": { + "type": "array", + "description": "The blob items.", + "items": { + "$ref": "#/definitions/BlobItem" + }, + "xml": { + "name": "Blob", + "wrapped": false + } + } }, - "description": "Specify an ETag value to operate only on blobs with a matching value." + "required": [ + "blobItems" + ], + "xml": { + "name": "Blobs" + } }, - "IfModifiedSince": { - "name": "If-Modified-Since", - "x-ms-client-name": "ifModifiedSince", - "in": "header", - "required": false, - "type": "string", - "format": "date-time-rfc1123", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "modified-access-conditions" + "BlobItem": { + "type": "object", + "description": "An Azure Storage blob.", + "properties": { + "name": { + "type": "string", + "description": "The blob name.", + "xml": { + "name": "Name" + } + }, + "deleted": { + "type": "boolean", + "description": "Whether the blob is deleted.", + "xml": { + "name": "Deleted" + } + }, + "snapshot": { + "type": "string", + "description": "The snapshot.", + "xml": { + "name": "Snapshot" + } + }, + "versionId": { + "type": "string", + "description": "The version ID.", + "xml": { + "name": "VersionId" + } + }, + "isCurrentVersion": { + "type": "boolean", + "description": "Whether this is the current version.", + "xml": { + "name": "IsCurrentVersion" + } + }, + "properties": { + "$ref": "#/definitions/BlobPropertiesInternal", + "description": "The blob properties.", + "xml": { + "name": "Properties" + } + }, + "deletionId": { + "type": "string", + "description": "The deletion ID.", + "xml": { + "name": "DeletionId" + } + } }, - "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." + "required": [ + "name", + "deleted", + "snapshot", + "properties" + ], + "xml": { + "name": "Blob" + } }, - "IfNoneMatch": { - "name": "If-None-Match", - "x-ms-client-name": "ifNoneMatch", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "modified-access-conditions" + "BlobPrefix": { + "type": "object", + "description": "A blob prefix.", + "properties": { + "name": { + "type": "string", + "description": "The prefix name.", + "xml": { + "name": "Name" + } + } }, - "description": "Specify an ETag value to operate only on blobs without a matching value." + "required": [ + "name" + ] }, - "IfUnmodifiedSince": { - "name": "If-Unmodified-Since", - "x-ms-client-name": "ifUnmodifiedSince", - "in": "header", - "required": false, - "type": "string", - "format": "date-time-rfc1123", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "modified-access-conditions" + "BlobPropertiesInternal": { + "type": "object", + "description": "Properties of a blob.", + "properties": { + "creationTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The creation time.", + "xml": { + "name": "Creation-Time" + } + }, + "lastModified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The last modified time.", + "xml": { + "name": "Last-Modified" + } + }, + "etag": { + "$ref": "#/definitions/Azure.Core.eTag", + "description": "The entity tag.", + "xml": { + "name": "Etag" + } + }, + "contentLength": { + "type": "integer", + "format": "int64", + "description": "Size in bytes.", + "xml": { + "name": "Content-Length" + } + }, + "contentType": { + "type": "string", + "description": "The content type.", + "xml": { + "name": "Content-Type" + } + }, + "contentEncoding": { + "type": "string", + "description": "The content encoding.", + "xml": { + "name": "Content-Encoding" + } + }, + "contentLanguage": { + "type": "string", + "description": "The content language.", + "xml": { + "name": "Content-Language" + } + }, + "contentMd5": { + "type": "string", + "format": "byte", + "description": "The content MD5 hash.", + "xml": { + "name": "Content-MD5" + } + }, + "contentDisposition": { + "type": "string", + "description": "The content disposition.", + "xml": { + "name": "Content-Disposition" + } + }, + "cacheControl": { + "type": "string", + "description": "The cache control.", + "xml": { + "name": "Cache-Control" + } + }, + "blobSequenceNumber": { + "type": "integer", + "format": "int64", + "description": "The blob sequence number.", + "xml": { + "name": "x-ms-blob-sequence-number" + } + }, + "copyId": { + "type": "string", + "description": "The copy ID.", + "xml": { + "name": "CopyId" + } + }, + "copySource": { + "type": "string", + "description": "The copy source.", + "xml": { + "name": "CopySource" + } + }, + "copyProgress": { + "type": "string", + "description": "The copy progress.", + "xml": { + "name": "CopyProgress" + } + }, + "copyCompletionTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The copy completion time.", + "xml": { + "name": "CopyCompletionTime" + } + }, + "copyStatusDescription": { + "type": "string", + "description": "The copy status description.", + "xml": { + "name": "CopyStatusDescription" + } + }, + "serverEncrypted": { + "type": "boolean", + "description": "Whether the server is encrypted.", + "xml": { + "name": "ServerEncrypted" + } + }, + "incrementalCopy": { + "type": "boolean", + "description": "Whether it is an incremental copy.", + "xml": { + "name": "IncrementalCopy" + } + }, + "destinationSnapshot": { + "type": "string", + "description": "The destination snapshot.", + "xml": { + "name": "DestinationSnapshot" + } + }, + "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" + } + }, + "accessTierInferred": { + "type": "boolean", + "description": "Whether the access tier is inferred.", + "xml": { + "name": "AccessTierInferred" + } + }, + "customerProvidedKeySha256": { + "type": "string", + "description": "The customer-provided key SHA256 hash.", + "xml": { + "name": "CustomerProvidedKeySha256" + } + }, + "encryptionScope": { + "type": "string", + "description": "The name of the encryption scope under which the blob is encrypted.", + "xml": { + "name": "EncryptionScope" + } + }, + "accessTierChangeTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The access tier change time.", + "xml": { + "name": "AccessTierChangeTime" + } + }, + "tagCount": { + "type": "integer", + "format": "int32", + "description": "The tag count.", + "xml": { + "name": "TagCount" + } + }, + "expiresOn": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The expiry time.", + "xml": { + "name": "Expiry-Time" + } + }, + "isSealed": { + "type": "boolean", + "description": "Whether the blob is sealed.", + "xml": { + "name": "Sealed" + } + }, + "lastAccessedOn": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The last accessed time.", + "xml": { + "name": "LastAccessTime" + } + }, + "deleteTime": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The delete time.", + "xml": { + "name": "DeleteTime" + } + } }, - "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." - }, - "RecursiveOptional": { - "name": "recursive", - "x-ms-parameter-location": "method", - "in": "query", - "description": "Required", - "required": false, - "type": "boolean" - }, - "RecursiveRequired": { - "name": "recursive", - "x-ms-parameter-location": "method", - "in": "query", - "description": "Required", - "required": true, - "type": "boolean" - }, - "Continuation": { - "name": "continuation", - "x-ms-parameter-location": "method", - "in": "query", - "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", - "required": false, - "type": "string" + "required": [ + "lastModified", + "etag" + ], + "xml": { + "name": "Properties" + } }, - "PathSetAccessControlRecursiveMode": { - "name": "mode", - "in": "query", - "x-ms-parameter-location": "method", - "description": "Mode \"set\" sets POSIX access control rights on files and directories, \"modify\" modifies one or more POSIX access control rights that pre-exist on files and directories, \"remove\" removes one or more POSIX access control rights that were present earlier on files and directories", - "required": true, + "EncryptionAlgorithmType": { "type": "string", + "description": "The encryption algorithm type.", "enum": [ - "set", - "modify", - "remove" + "AES256" ], "x-ms-enum": { - "name": "PathSetAccessControlRecursiveMode", - "modelAsString": false + "name": "EncryptionAlgorithmType", + "modelAsString": false, + "values": [ + { + "name": "AES256", + "value": "AES256", + "description": "The AES256 encryption algorithm." + } + ] } }, - "ForceFlag": { - "name": "forceFlag", - "x-ms-parameter-location": "method", - "in": "query", - "description": "Optional. Valid for \"SetAccessControlRecursive\" operation. If set to false, the operation will terminate quickly on encountering user errors (4XX). If true, the operation will ignore user errors and proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag is true in case of user errors. If not set the default value is false for this.", - "required": false, - "type": "boolean" - }, - "Directory": { - "name": "directory", - "x-ms-client-name": "Path", - "x-ms-parameter-location": "method", - "in": "query", - "description": "Optional. Filters results to paths within the specified directory. An error occurs if the directory does not exist.", - "required": false, - "type": "string" - }, - "LeaseIdOptional": { - "name": "x-ms-lease-id", - "x-ms-client-name": "leaseId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "lease-access-conditions" - }, - "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + "FileSystemItem": { + "type": "object", + "description": "Represents a filesystem.", + "properties": { + "name": { + "type": "string", + "description": "The filesystem name." + }, + "lastModified": { + "type": "string", + "description": "The last modified time." + }, + "eTag": { + "$ref": "#/definitions/Azure.Core.eTag", + "description": "The entity tag." + } + } }, - "LeaseIdRequired": { - "name": "x-ms-lease-id", - "x-ms-client-name": "leaseId", - "in": "header", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Specifies the current lease ID on the resource." + "FileSystemList": { + "type": "object", + "description": "A list of filesystems.", + "properties": { + "filesystems": { + "type": "array", + "description": "The list of filesystems.", + "items": { + "$ref": "#/definitions/FileSystemItem" + }, + "xml": { + "wrapped": true + } + } + } }, - "ProposedLeaseIdOptional": { - "name": "x-ms-proposed-lease-id", - "x-ms-client-name": "proposedLeaseId", - "in": "header", - "required": false, + "FileSystemResourceType": { "type": "string", - "x-ms-parameter-location": "method", - "description": "Proposed lease ID, in a GUID string format. The Blob 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." - }, - "LeaseDuration": { - "name": "x-ms-lease-duration", - "in": "header", - "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", - "format": "int32", - "required": false, - "type": "integer", - "x-ms-parameter-location": "client" - }, - "LeaseDurationMethod": { - "name": "x-ms-lease-duration", - "x-ms-client-name": "leaseDuration", - "in": "header", - "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", - "format": "int64", - "required": false, - "type": "integer", - "x-ms-parameter-location": "method" + "description": "The value must be \"filesystem\" for all filesystem operations.", + "enum": [ + "filesystem" + ], + "x-ms-enum": { + "name": "FileSystemResourceType", + "modelAsString": false, + "values": [ + { + "name": "filesystem", + "value": "filesystem", + "description": "The filesystem resource type." + } + ] + } }, "LeaseAction": { - "name": "x-ms-lease-action", - "x-ms-client-name": "leaseAction", - "in": "header", - "x-ms-parameter-location": "method", - "description": "Optional. If \"acquire\" it will acquire the lease. If \"auto-renew\" it will renew the lease. If \"release\" it will release the lease only on flush. If \"acquire-release\" it will acquire & complete the operation & release the lease once operation is done.", - "required": false, "type": "string", + "description": "The lease action for append and flush operations.", "enum": [ "acquire", "auto-renew", @@ -2830,897 +4234,539 @@ ], "x-ms-enum": { "name": "LeaseAction", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "name": "acquire", + "value": "acquire", + "description": "Acquire a lease." + }, + { + "name": "auto-renew", + "value": "auto-renew", + "description": "Auto-renew the lease." + }, + { + "name": "release", + "value": "release", + "description": "Release the lease only on flush." + }, + { + "name": "acquire-release", + "value": "acquire-release", + "description": "Acquire, complete the operation, and release the lease." + } + ] } }, - "Prefix": { - "name": "prefix", - "in": "query", - "description": "Filters results to filesystems within the specified prefix.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "MaxResults": { - "name": "maxResults", - "in": "query", - "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", - "format": "int32", - "minimum": 1, - "required": false, - "type": "integer", - "x-ms-parameter-location": "method" - }, - "Properties": { - "name": "x-ms-properties", - "x-ms-client-name": "properties", - "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SourceIfMatch": { - "name": "x-ms-source-if-match", - "x-ms-client-name": "sourceIfMatch", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "source-modified-access-conditions" - }, - "description": "Specify an ETag value to operate only on blobs with a matching value." - }, - "SourceIfModifiedSince": { - "name": "x-ms-source-if-modified-since", - "x-ms-client-name": "sourceIfModifiedSince", - "in": "header", - "required": false, - "type": "string", - "format": "date-time-rfc1123", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "source-modified-access-conditions" - }, - "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." - }, - "SourceIfNoneMatch": { - "name": "x-ms-source-if-none-match", - "x-ms-client-name": "sourceIfNoneMatch", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "source-modified-access-conditions" - }, - "description": "Specify an ETag value to operate only on blobs without a matching value." - }, - "SourceIfUnmodifiedSince": { - "name": "x-ms-source-if-unmodified-since", - "x-ms-client-name": "sourceIfUnmodifiedSince", - "in": "header", - "required": false, - "type": "string", - "format": "date-time-rfc1123", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "source-modified-access-conditions" - }, - "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." - }, - "SourceLeaseId": { - "name": "x-ms-source-lease-id", - "x-ms-client-name": "sourceLeaseId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match." - }, - "FileSystem": { - "name": "filesystem", - "x-ms-parameter-location": "client", - "x-ms-client-name": "fileSystem", - "in": "path", - "description": "The filesystem identifier.", - "pattern": "^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", - "minLength": 3, - "maxLength": 63, - "required": true, - "type": "string" - }, - "Path": { - "name": "path", - "x-ms-parameter-location": "client", - "in": "path", - "description": "The file or directory path.", - "required": true, - "type": "string" - }, - "CacheControl": { - "name": "x-ms-cache-control", - "x-ms-client-name": "cacheControl", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "path-HTTP-headers" - }, - "description": "Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request." - }, - "ContentDisposition": { - "name": "x-ms-content-disposition", - "x-ms-client-name": "contentDisposition", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "path-HTTP-headers" - }, - "description": "Optional. Sets the blob's Content-Disposition header." - }, - "ContentEncoding": { - "name": "x-ms-content-encoding", - "x-ms-client-name": "contentEncoding", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "path-HTTP-headers" - }, - "description": "Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request." - }, - "ContentLanguage": { - "name": "x-ms-content-language", - "x-ms-client-name": "contentLanguage", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "path-HTTP-headers" - }, - "description": "Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request." - }, - "ContentType": { - "name": "x-ms-content-type", - "x-ms-client-name": "contentType", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "path-HTTP-headers" - }, - "description": "Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request." - }, - "TransactionalContentMD5": { - "name": "Content-MD5", - "x-ms-client-name": "transactionalContentHash", - "in": "header", - "required": false, - "type": "string", - "format": "byte", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "path-HTTP-headers" - }, - "description": "Specify the transactional md5 for the body, to be validated by the service." - }, - "ContentMD5": { - "name": "x-ms-content-md5", - "x-ms-client-name": "contentMD5", - "in": "header", - "required": false, - "type": "string", - "format": "byte", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "path-HTTP-headers" - }, - "description": "Specify the transactional md5 for the body, to be validated by the service." - }, - "ContentCrc64": { - "name": "x-ms-content-crc64", - "x-ms-client-name": "transactionalContentCrc64", - "in": "header", - "required": false, - "type": "string", - "format": "byte", - "x-ms-parameter-location": "method", - "description": "Specify the transactional crc64 for the body, to be validated by the service." - }, - "StructuredBodyPut": { - "name": "x-ms-structured-body", - "x-ms-client-name": "StructuredBodyType", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Required if the request body is a structured message. Specifies the message schema version and properties." - }, - "StructuredContentLength": { - "name": "x-ms-structured-content-length", - "x-ms-client-name": "StructuredContentLength", - "in": "header", - "required": false, - "type": "integer", - "format": "int64", - "x-ms-parameter-location": "method", - "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." - }, - "Umask": { - "name": "x-ms-umask", - "x-ms-client-name": "umask", - "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p bitwise and not u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "Permissions": { - "name": "x-ms-permissions", - "x-ms-client-name": "permissions", - "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "RenameSource": { - "name": "x-ms-rename-source", - "x-ms-client-name": "renameSource", - "in": "header", - "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "Owner": { - "name": "x-ms-owner", - "x-ms-client-name": "owner", - "in": "header", - "required": false, - "type": "string", - "description": "Optional. The owner of the blob or directory.", - "x-ms-parameter-location": "method" - }, - "Group": { - "name": "x-ms-group", - "x-ms-client-name": "group", - "in": "header", - "required": false, - "type": "string", - "description": "Optional. The owning group of the blob or directory.", - "x-ms-parameter-location": "method" - }, - "Acl": { - "name": "x-ms-acl", - "description": "Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\".", - "x-ms-client-name": "acl", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "Body": { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "format": "file" + "ListBlobsHierarchySegmentResponse": { + "type": "object", + "description": "An enumeration of blobs.", + "properties": { + "serviceEndpoint": { + "type": "string", + "description": "The service endpoint.", + "xml": { + "name": "ServiceEndpoint", + "attribute": true + } + }, + "containerName": { + "type": "string", + "description": "The container name.", + "xml": { + "name": "ContainerName", + "attribute": true + } + }, + "prefix": { + "type": "string", + "description": "The prefix filter.", + "xml": { + "name": "Prefix" + } + }, + "marker": { + "type": "string", + "description": "The marker for pagination.", + "xml": { + "name": "Marker" + } + }, + "maxResults": { + "type": "integer", + "format": "int32", + "description": "The maximum number of results.", + "xml": { + "name": "MaxResults" + } + }, + "delimiter": { + "type": "string", + "description": "The delimiter used for hierarchy.", + "xml": { + "name": "Delimiter" + } + }, + "segment": { + "$ref": "#/definitions/BlobHierarchyListSegment", + "description": "The blob segment.", + "xml": { + "name": "Blobs" + } + }, + "nextMarker": { + "type": "string", + "description": "The next marker for pagination.", + "xml": { + "name": "NextMarker" + } + } }, - "x-ms-parameter-location": "method", - "description": "Initial data" - }, - "Upn": { - "name": "upn", - "in": "query", - "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.", - "required": false, - "type": "boolean", - "x-ms-parameter-location": "method" - }, - "Position": { - "name": "position", - "in": "query", - "description": "This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.", - "format": "int64", - "required": false, - "type": "integer", - "x-ms-parameter-location": "method" - }, - "RetainUncommittedData": { - "name": "retainUncommittedData", - "in": "query", - "description": "Valid only for flush operations. If \"true\", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.", - "required": false, - "type": "boolean", - "x-ms-parameter-location": "method" - }, - "Close": { - "name": "close", - "in": "query", - "description": "Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is \"flush\" and change notifications are enabled. If the value of close is \"true\" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If \"false\" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed.\"", - "required": false, - "type": "boolean", - "x-ms-parameter-location": "method" - }, - "ContentLength": { - "name": "Content-Length", - "in": "header", - "description": "Required for \"Append Data\" and \"Flush Data\". Must be 0 for \"Flush Data\". Must be the length of the request content in bytes for \"Append Data\".", - "minimum": 0, - "required": false, - "type": "integer", - "format": "int64", - "x-ms-parameter-location": "method" - }, - "PathExpiryOptions": { - "name": "x-ms-expiry-option", - "x-ms-client-name": "ExpiryOptions", - "in": "header", - "required": true, - "type": "string", - "enum": [ - "NeverExpire", - "RelativeToCreation", - "RelativeToNow", - "Absolute" + "required": [ + "serviceEndpoint", + "containerName", + "segment" ], - "x-ms-enum": { - "name": "PathExpiryOptions", - "modelAsString": true - }, - "x-ms-parameter-location": "method", - "description": "Required. Indicates mode of the expiry time" + "xml": { + "name": "EnumerationResults" + } }, - "PathExpiryOptionsOptional": { - "name": "x-ms-expiry-option", - "x-ms-client-name": "ExpiryOptions", - "in": "header", - "required": false, + "ListBlobsIncludeItem": { "type": "string", + "description": "Include this parameter to specify one or more datasets to include in the response.", "enum": [ - "NeverExpire", - "RelativeToCreation", - "RelativeToNow", - "Absolute" + "copy", + "deleted", + "metadata", + "snapshots", + "uncommittedblobs", + "versions", + "tags" ], "x-ms-enum": { - "name": "PathExpiryOptions", - "modelAsString": true - }, - "x-ms-parameter-location": "method", - "description": "Required. Indicates mode of the expiry time" - }, - "PathExpiryTime": { - "name": "x-ms-expiry-time", - "x-ms-client-name": "ExpiresOn", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The time to set the blob to expiry" - }, - "UndeleteSource": { - "name": "x-ms-undelete-source", - "x-ms-client-name": "UndeleteSource", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Only for hierarchical namespace enabled accounts. Optional. The path of the soft deleted blob to undelete." - }, - "Marker": { - "name": "marker", - "in": "query", - "required": false, - "type": "string", - "description": "A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.", - "x-ms-parameter-location": "method" - }, - "ListBlobsInclude": { - "name": "include", - "in": "query", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string", - "enum": [ - "copy", - "deleted", - "metadata", - "snapshots", - "uncommittedblobs", - "versions", - "tags" - ], - "x-ms-enum": { - "name": "ListBlobsIncludeItem", - "modelAsString": false - } - }, - "x-ms-parameter-location": "method", - "description": "Include this parameter to specify one or more datasets to include in the response." + "name": "ListBlobsIncludeItem", + "modelAsString": false, + "values": [ + { + "name": "copy", + "value": "copy", + "description": "Include copy information." + }, + { + "name": "deleted", + "value": "deleted", + "description": "Include deleted blobs." + }, + { + "name": "metadata", + "value": "metadata", + "description": "Include metadata." + }, + { + "name": "snapshots", + "value": "snapshots", + "description": "Include snapshots." + }, + { + "name": "uncommittedblobs", + "value": "uncommittedblobs", + "description": "Include uncommitted blobs." + }, + { + "name": "versions", + "value": "versions", + "description": "Include versions." + }, + { + "name": "tags", + "value": "tags", + "description": "Include tags." + } + ] + } }, "ListBlobsShowOnly": { - "name": "showonly", - "in": "query", - "required": false, "type": "string", + "description": "The show only filter for list blobs.", "enum": [ "deleted" ], "x-ms-enum": { "name": "ListBlobsShowOnly", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "description": "Include this parameter to specify one or more datasets to include in the response." - }, - "Delimiter": { - "name": "delimiter", - "description": "When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.", - "type": "string", - "x-ms-parameter-location": "method", - "in": "query", - "required": false - }, - "EncryptionKey": { - "name": "x-ms-encryption-key", - "x-ms-client-name": "encryptionKey", - "type": "string", - "in": "header", - "required": false, - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "cpk-info" - }, - "description": "Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services." - }, - "EncryptionKeySha256": { - "name": "x-ms-encryption-key-sha256", - "x-ms-client-name": "encryptionKeySha256", - "type": "string", - "in": "header", - "required": false, - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "cpk-info" - }, - "description": "The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided." + "modelAsString": false, + "values": [ + { + "name": "deleted", + "value": "deleted", + "description": "Show only deleted blobs." + } + ] + } }, - "EncryptionAlgorithm": { - "name": "x-ms-encryption-algorithm", - "x-ms-client-name": "encryptionAlgorithm", + "PathExpiryOptions": { "type": "string", - "in": "header", - "required": false, + "description": "The path expiry options.", "enum": [ - "AES256" - ], - "x-ms-enum": { - "name": "EncryptionAlgorithmType", - "modelAsString": false - }, - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "cpk-info" - }, - "description": "The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided." - }, - "Flush": { - "name": "flush", - "type": "boolean", - "in": "query", - "required": false, - "x-ms-parameter-location": "method", - "description": "If file should be flushed after the append" - }, - "EncryptionContext": { - "name": "x-ms-encryption-context", - "x-ms-client-name": "encryptionContext", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Specifies the encryption context to set on the file." - }, - "Paginated": { - "name": "paginated", - "in": "query", - "description": "If true, paginated behavior will be seen. Pagination is for the recursive ACL checks as a POSIX requirement in the server and Delete in an atomic operation once the ACL checks are completed. If false or missing, normal default behavior will kick in, which may timeout in case of very large directories due to recursive ACL checks. This new parameter is introduced for backward compatibility. ", - "x-ms-parameter-location": "method", - "required": false, - "type": "boolean" - }, - "BeginFrom": { - "name": "beginFrom", - "in": "query", - "description": "Optional. A relative path within the specified directory where the listing will start from. For example, a recursive listing under directory folder1/folder2 with beginFrom as folder3/readmefile.txt will start listing from folder1/folder2/folder3/readmefile.txt. Please note that, multiple entity levels are supported for recursive listing. Non-recursive listing supports only one entity level. An error will appear if multiple entity levels are specified for non-recursive listing.", - "x-ms-parameter-location": "method", - "required": false, - "type": "string" - } - }, - "definitions": { - "AclFailedEntry": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "errorMessage": { - "type": "string" - } + "NeverExpire", + "RelativeToCreation", + "RelativeToNow", + "Absolute" + ], + "x-ms-enum": { + "name": "PathExpiryOptions", + "modelAsString": true, + "values": [ + { + "name": "NeverExpire", + "value": "NeverExpire", + "description": "Never expire." + }, + { + "name": "RelativeToCreation", + "value": "RelativeToCreation", + "description": "Relative to creation time." + }, + { + "name": "RelativeToNow", + "value": "RelativeToNow", + "description": "Relative to now." + }, + { + "name": "Absolute", + "value": "Absolute", + "description": "Absolute time." + } + ] } }, - "SetAccessControlRecursiveResponse": { - "type": "object", - "properties": { - "directoriesSuccessful": { - "type": "integer", - "format": "int32" - }, - "filesSuccessful": { - "type": "integer", - "format": "int32" - }, - "failureCount": { - "type": "integer", - "format": "int32" - }, - "failedEntries": { - "type": "array", - "items": { - "$ref": "#/definitions/AclFailedEntry" + "PathGetPropertiesAction": { + "type": "string", + "description": "The action for Path_GetProperties.", + "enum": [ + "getAccessControl", + "getStatus" + ], + "x-ms-enum": { + "name": "PathGetPropertiesAction", + "modelAsString": false, + "values": [ + { + "name": "getAccessControl", + "value": "getAccessControl", + "description": "Get access control list." + }, + { + "name": "getStatus", + "value": "getStatus", + "description": "Get status." } - } + ] } }, - "Path": { + "PathItem": { "type": "object", + "description": "Represents a path in a filesystem.", "properties": { "name": { - "type": "string" + "type": "string", + "description": "The path name." }, "isDirectory": { - "default": false, - "type": "boolean" + "type": "boolean", + "description": "Whether the path is a directory.", + "default": false }, "lastModified": { - "type": "string" + "type": "string", + "description": "The last modified time." }, "eTag": { - "type": "string" + "$ref": "#/definitions/Azure.Core.eTag", + "description": "The entity tag." }, "contentLength": { "type": "integer", - "format": "int64" + "format": "int64", + "description": "The content length." }, "owner": { - "type": "string" + "type": "string", + "description": "The owner of the path." }, "group": { - "type": "string" + "type": "string", + "description": "The owning group of the path." }, "permissions": { - "type": "string" + "type": "string", + "description": "The POSIX access permissions." }, "EncryptionScope": { "type": "string", - "description": "The name of the encryption scope under which the blob is encrypted." + "description": "The name of the encryption scope under which the blob is encrypted.", + "xml": { + "name": "encryptionScope" + }, + "x-ms-client-name": "encryptionScope" }, "creationTime": { - "type": "string" + "type": "string", + "description": "The creation time." }, "expiryTime": { - "type": "string" + "type": "string", + "description": "The expiry time." }, "EncryptionContext": { - "type": "string" + "type": "string", + "description": "The encryption context.", + "xml": { + "name": "encryptionContext" + }, + "x-ms-client-name": "encryptionContext" } } }, + "PathLeaseAction": { + "type": "string", + "description": "The lease action for Path_Lease.", + "enum": [ + "acquire", + "break", + "change", + "renew", + "release" + ], + "x-ms-enum": { + "name": "PathLeaseAction", + "modelAsString": false, + "values": [ + { + "name": "acquire", + "value": "acquire", + "description": "Acquire a new lease." + }, + { + "name": "break", + "value": "break", + "description": "Break an existing lease." + }, + { + "name": "change", + "value": "change", + "description": "Change the lease ID of an active lease." + }, + { + "name": "renew", + "value": "renew", + "description": "Renew an existing lease." + }, + { + "name": "release", + "value": "release", + "description": "Release a lease." + } + ] + } + }, "PathList": { "type": "object", + "description": "A list of paths.", "properties": { "paths": { "type": "array", + "description": "The list of paths.", "items": { - "$ref": "#/definitions/Path" + "$ref": "#/definitions/PathItem" + }, + "xml": { + "wrapped": true } } } }, - "FileSystem": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "lastModified": { - "type": "string" - }, - "eTag": { - "type": "string" - } - } - }, - "ListBlobsHierarchySegmentResponse": { - "xml": { - "name": "EnumerationResults" - }, - "description": "An enumeration of blobs", - "type": "object", - "required": [ - "ServiceEndpoint", - "ContainerName", - "Segment" + "PathRenameMode": { + "type": "string", + "description": "The rename mode. The value must be \"legacy\" or \"posix\".", + "enum": [ + "legacy", + "posix" ], - "properties": { - "ServiceEndpoint": { - "type": "string", - "xml": { - "attribute": true - } - }, - "ContainerName": { - "type": "string", - "xml": { - "attribute": true + "x-ms-enum": { + "name": "PathRenameMode", + "modelAsString": false, + "values": [ + { + "name": "legacy", + "value": "legacy", + "description": "Legacy rename mode." + }, + { + "name": "posix", + "value": "posix", + "description": "POSIX rename mode." } - }, - "Prefix": { - "type": "string" - }, - "Marker": { - "type": "string" - }, - "MaxResults": { - "type": "integer" - }, - "Delimiter": { - "type": "string" - }, - "Segment": { - "$ref": "#/definitions/BlobHierarchyListSegment" - }, - "NextMarker": { - "type": "string" - } + ] } }, - "BlobHierarchyListSegment": { - "xml": { - "name": "Blobs" - }, - "type": "object", - "required": [ - "BlobItems" + "PathResourceType": { + "type": "string", + "description": "Required only for Create File and Create Directory. The value must be \"file\" or \"directory\".", + "enum": [ + "directory", + "file" ], - "properties": { - "BlobPrefixes": { - "type": "array", - "items": { - "$ref": "#/definitions/BlobPrefix" - } - }, - "BlobItems": { - "type": "array", - "items": { - "$ref": "#/definitions/BlobItemInternal" + "x-ms-enum": { + "name": "PathResourceType", + "modelAsString": false, + "values": [ + { + "name": "directory", + "value": "directory", + "description": "A directory resource type." + }, + { + "name": "file", + "value": "file", + "description": "A file resource type." } - } + ] } }, - "BlobPrefix": { - "type": "object", - "required": [ - "Name" + "PathSetAccessControlRecursiveMode": { + "type": "string", + "description": "The mode for recursive access control operations.", + "enum": [ + "set", + "modify", + "remove" ], - "properties": { - "Name": { - "type": "string" - } + "x-ms-enum": { + "name": "PathSetAccessControlRecursiveMode", + "modelAsString": false, + "values": [ + { + "name": "set", + "value": "set", + "description": "Set POSIX access control rights." + }, + { + "name": "modify", + "value": "modify", + "description": "Modify POSIX access control rights." + }, + { + "name": "remove", + "value": "remove", + "description": "Remove POSIX access control rights." + } + ] } }, - "BlobItemInternal": { - "xml": { - "name": "Blob" - }, - "description": "An Azure Storage blob", - "type": "object", - "required": [ - "Name", - "Deleted", - "Snapshot", - "Properties" + "PathUpdateAction": { + "type": "string", + "description": "The action to perform on the path during update.", + "enum": [ + "append", + "flush", + "setProperties", + "setAccessControl", + "setAccessControlRecursive" ], - "properties": { - "Name": { - "type": "string" - }, - "Deleted": { - "type": "boolean" - }, - "Snapshot": { - "type": "string" - }, - "VersionId": { - "type": "string" - }, - "IsCurrentVersion": { - "type": "boolean" - }, - "Properties": { - "$ref": "#/definitions/BlobPropertiesInternal" - }, - "DeletionId": { - "type": "string" - } + "x-ms-enum": { + "name": "PathUpdateAction", + "modelAsString": false, + "values": [ + { + "name": "append", + "value": "append", + "description": "Append data to the file." + }, + { + "name": "flush", + "value": "flush", + "description": "Flush previously uploaded data to a file." + }, + { + "name": "setProperties", + "value": "setProperties", + "description": "Set the properties of a file or directory." + }, + { + "name": "setAccessControl", + "value": "setAccessControl", + "description": "Set the access control for a file or directory." + }, + { + "name": "setAccessControlRecursive", + "value": "setAccessControlRecursive", + "description": "Set the access control list for a directory recursively." + } + ] } }, - "BlobPropertiesInternal": { - "xml": { - "name": "Properties" - }, - "description": "Properties of a blob", + "SetAccessControlRecursiveResponse": { "type": "object", - "required": [ - "Etag", - "Last-Modified" - ], + "description": "The response for set access control recursive operations.", "properties": { - "Creation-Time": { - "type": "string", - "format": "date-time-rfc1123" - }, - "Last-Modified": { - "type": "string", - "format": "date-time-rfc1123" - }, - "Etag": { - "type": "string" - }, - "Content-Length": { + "directoriesSuccessful": { "type": "integer", - "format": "int64", - "description": "Size in bytes" - }, - "Content-Type": { - "type": "string" - }, - "Content-Encoding": { - "type": "string" - }, - "Content-Language": { - "type": "string" - }, - "Content-MD5": { - "type": "string", - "format": "byte" - }, - "Content-Disposition": { - "type": "string" + "format": "int32", + "description": "The number of directories successfully processed." }, - "Cache-Control": { - "type": "string" - }, - "x-ms-blob-sequence-number": { - "x-ms-client-name": "blobSequenceNumber", + "filesSuccessful": { "type": "integer", - "format": "int64" - }, - "CopyId": { - "type": "string" - }, - "CopySource": { - "type": "string" - }, - "CopyProgress": { - "type": "string" - }, - "CopyCompletionTime": { - "type": "string", - "format": "date-time-rfc1123" - }, - "CopyStatusDescription": { - "type": "string" - }, - "ServerEncrypted": { - "type": "boolean" - }, - "IncrementalCopy": { - "type": "boolean" - }, - "DestinationSnapshot": { - "type": "string" - }, - "DeletedTime": { - "type": "string", - "format": "date-time-rfc1123" - }, - "RemainingRetentionDays": { - "type": "integer" - }, - "AccessTierInferred": { - "type": "boolean" - }, - "CustomerProvidedKeySha256": { - "type": "string" - }, - "EncryptionScope": { - "type": "string", - "description": "The name of the encryption scope under which the blob is encrypted." - }, - "AccessTierChangeTime": { - "type": "string", - "format": "date-time-rfc1123" - }, - "TagCount": { - "type": "integer" + "format": "int32", + "description": "The number of files successfully processed." }, - "Expiry-Time": { - "x-ms-client-name": "ExpiresOn", - "type": "string", - "format": "date-time-rfc1123" - }, - "Sealed": { - "x-ms-client-name": "IsSealed", - "type": "boolean" - }, - "LastAccessTime": { - "x-ms-client-name": "LastAccessedOn", - "type": "string", - "format": "date-time-rfc1123" + "failureCount": { + "type": "integer", + "format": "int32", + "description": "The number of failures." }, - "DeleteTime": { - "type": "string", - "format": "date-time-rfc1123" - } - } - }, - "FileSystemList": { - "type": "object", - "properties": { - "filesystems": { + "failedEntries": { "type": "array", + "description": "The list of failed entries.", "items": { - "$ref": "#/definitions/FileSystem" + "$ref": "#/definitions/AclFailedEntry" + }, + "xml": { + "wrapped": true } } } }, "StorageError": { "type": "object", + "description": "The storage error response.", "properties": { "error": { - "type": "object", - "description": "The service error response object.", - "properties": { - "Code": { - "description": "The service error code.", - "type": "string" - }, - "Message": { - "description": "The service error message.", - "type": "string" - } + "$ref": "#/definitions/StorageErrorBody", + "description": "The service error response object." + } + } + }, + "StorageErrorBody": { + "type": "object", + "description": "The service error response body.", + "properties": { + "code": { + "type": "string", + "description": "The service error code.", + "xml": { + "name": "Code" + } + }, + "message": { + "type": "string", + "description": "The service error message.", + "xml": { + "name": "Message" } } } } - } -} + }, + "parameters": {} +} \ No newline at end of file