openapi-directory/api/azure.com/storage-DataLakeStorage.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Azure Data Lake Storage provides storage for Hadoop and other big data workloads.","title":"Azure Data Lake Storage","version":"2019-10-31","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-ms-code-generation-settings":{"name":"DataLakeStorageClient"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2019-10-31/DataLakeStorage.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"storage-DataLakeStorage","x-tags":["Azure","Microsoft"]},"tags":[{"name":"Account Operations"},{"name":"Filesystem Operations"},{"name":"File and Directory Operations"}],"paths":{"/":{"get":{"description":"List filesystems and their properties in given account.","operationId":"Filesystem_List","parameters":[{"description":"The value must be \"account\" for all account operations.","in":"query","name":"resource","required":true,"x-ms-enum":{"modelAsString":false,"name":"AccountResourceType"},"schema":{"type":"string","enum":["account"]}},{"description":"Filters results to filesystems within the specified prefix.","in":"query","name":"prefix","required":false,"schema":{"type":"string"}},{"description":"The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned 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 specified in a subsequent invocation of the list operation to continue listing the filesystems.","in":"query","name":"continuation","required":false,"schema":{"type":"string"}},{"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.","in":"query","name":"maxResults","required":false,"schema":{"type":"integer","format":"int32","minimum":1}},{"description":"A UUID recorded in the analytics logs for troubleshooting and correlation.","in":"header","name":"x-ms-client-request-id","required":false,"x-ms-client-request-id":true,"schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},{"description":"An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.","in":"query","name":"timeout","required":false,"schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Specifies the Coordinated Universal Time (UTC) for the request.  This is required when using shared key authorization.","in":"header","name":"x-ms-date","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"description":"The content type of list filesystem response. The default content type is application/json.","schema":{"type":"string"}},"Date":{"description":"A UTC date/time value generated by the service that indicates the time at which the response was initiated.","schema":{"type":"string"}},"x-ms-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.","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesystemList"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"List Filesystems","tags":["Account Operations"],"x-ms-pageable":{"itemName":"filesystems"}}},"/{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://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).","operationId":"Filesystem_Delete","parameters":[{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.","in":"header","name":"If-Modified-Since","required":false,"schema":{"type":"string"}},{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.","in":"header","name":"If-Unmodified-Since","required":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted","headers":{"Date":{"description":"A UTC date/time value generated by the service that indicates the time at which the response was initiated.","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Delete Filesystem","tags":["Filesystem Operations"]},"get":{"description":"List filesystem paths and their properties.","operationId":"Path_List","parameters":[{"description":"Filters results to paths within the specified directory. An error occurs if the directory does not exist.","in":"query","name":"directory","required":false,"schema":{"type":"string"}},{"description":"If \"true\", all paths are listed; otherwise, only paths at the root of the filesystem are listed.  If \"directory\" is specified, the list will only include paths that share the same root.","in":"query","name":"recursive","required":true,"schema":{"type":"boolean"}},{"description":"The number of paths returned with each invocation is limited. If the number of paths to be returned 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 specified in a subsequent invocation of the list operation to continue listing the paths.","in":"query","name":"continuation","required":false,"schema":{"type":"string"}},{"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.","in":"query","name":"maxResults","required":false,"schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the owner and group fields of each list entry 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.","in":"query","name":"upn","required":false,"schema":{"type":"boolean"}}],"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.","schema":{"type":"string"}},"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.","schema":{"type":"string"}},"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.","schema":{"type":"string"}},"x-ms-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.","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathList"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"List Paths","tags":["Filesystem Operations"],"x-ms-pageable":{"itemName":"paths"}},"head":{"description":"All system and user-defined filesystem properties are specified in the response headers.","operationId":"Filesystem_GetProperties","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.","schema":{"type":"string"}},"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.","schema":{"type":"string"}},"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.","schema":{"type":"string"}},"x-ms-namespace-enabled":{"description":"A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.  ","schema":{"type":"string"}},"x-ms-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.","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Get Filesystem Properties.","tags":["Filesystem Operations"]},"parameters":[{"description":"The filesystem identifier.  The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character.  Consecutive dashes are not permitted.  All letters must be lowercase.  The value must have between 3 and 63 characters.","in":"path","name":"filesystem","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$"}},{"description":"The value must be \"filesystem\" for all filesystem operations.","in":"query","name":"resource","required":true,"x-ms-enum":{"modelAsString":false,"name":"FilesystemResourceType"},"schema":{"type":"string","enum":["filesystem"]}},{"description":"A UUID recorded in the analytics logs for troubleshooting and correlation.","in":"header","name":"x-ms-client-request-id","required":false,"x-ms-client-request-id":true,"schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},{"description":"An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.","in":"query","name":"timeout","required":false,"schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Specifies the Coordinated Universal Time (UTC) for the request.  This is required when using shared key authorization.","in":"header","name":"x-ms-date","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Version"}],"patch":{"description":"Set properties for the filesystem.  This operation supports conditional HTTP requests.  For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).","operationId":"Filesystem_SetProperties","parameters":[{"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","name":"x-ms-properties","required":false,"schema":{"type":"string"}},{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.","in":"header","name":"If-Modified-Since","required":false,"schema":{"type":"string"}},{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.","in":"header","name":"If-Unmodified-Since","required":false,"schema":{"type":"string"}}],"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.","schema":{"type":"string"}},"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.","schema":{"type":"string"}},"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.","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Set Filesystem Properties","tags":["Filesystem Operations"]},"put":{"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.","operationId":"Filesystem_Create","parameters":[{"description":"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.","in":"header","name":"x-ms-properties","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","headers":{"Date":{"description":"A UTC date/time value generated by the service that indicates the time at which the response was initiated.","schema":{"type":"string"}},"ETag":{"description":"An HTTP entity tag associated with the filesystem.","schema":{"type":"string"}},"Last-Modified":{"description":"The data and time the filesystem was last modified.  Operations on files and directories do not affect the last modified time.","schema":{"type":"string"}},"x-ms-namespace-enabled":{"description":"A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.  ","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Create Filesystem","tags":["Filesystem Operations"]}},"/{filesystem}/{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://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).","operationId":"Path_Delete","parameters":[{"description":"Required and valid only when the resource is a directory.  If \"true\", all paths beneath the directory will be deleted. If \"false\" and the directory is non-empty, an error occurs.","in":"query","name":"recursive","required":false,"schema":{"type":"boolean"}},{"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.","in":"query","name":"continuation","required":false,"schema":{"type":"string"}},{"description":"The lease ID must be specified if there is an active lease.","in":"header","name":"x-ms-lease-id","required":false,"schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},{"description":"Optional.  An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}},{"description":"Optional.  An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.","in":"header","name":"If-None-Match","required":false,"schema":{"type":"string"}},{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.","in":"header","name":"If-Modified-Since","required":false,"schema":{"type":"string"}},{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.","in":"header","name":"If-Unmodified-Since","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file was deleted.","headers":{"Date":{"description":"A UTC date/time value generated by the service that indicates the time at which the response was initiated.","schema":{"type":"string"}},"x-ms-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.","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Delete File | Delete Directory","tags":["File and Directory Operations"]},"get":{"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://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).","operationId":"Path_Read","parameters":[{"description":"The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.","in":"header","name":"Range","required":false,"schema":{"type":"string"}},{"description":"Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path.","in":"header","name":"x-ms-lease-id","required":false,"schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},{"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).","in":"header","name":"x-ms-range-get-content-md5","required":false,"schema":{"type":"boolean"}},{"description":"Optional.  An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}},{"description":"Optional.  An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.","in":"header","name":"If-None-Match","required":false,"schema":{"type":"string"}},{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.","in":"header","name":"If-Modified-Since","required":false,"schema":{"type":"string"}},{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.","in":"header","name":"If-Unmodified-Since","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","headers":{"Accept-Ranges":{"description":"Indicates that the service supports requests for partial file content.","schema":{"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.","schema":{"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.","schema":{"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.","schema":{"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.","schema":{"type":"string"}},"Content-Length":{"description":"The size of the resource in bytes.","schema":{"type":"integer","format":"int64"}},"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.","schema":{"type":"string"}},"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.","schema":{"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.","schema":{"type":"string"}},"Date":{"description":"A UTC date/time value generated by the service that indicates the time at which the response was initiated.","schema":{"type":"string"}},"ETag":{"description":"An HTTP entity tag associated with the file or directory.","schema":{"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.","schema":{"type":"string"}},"x-ms-lease-duration":{"description":"When a resource is leased, specifies whether the lease is of infinite or fixed duration.","schema":{"type":"string"}},"x-ms-lease-state":{"description":"Lease state of the resource. ","schema":{"type":"string"}},"x-ms-lease-status":{"description":"The lease status of the resource.","schema":{"type":"string"}},"x-ms-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.","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-resource-type":{"description":"The type of the resource.  The value may be \"file\" or \"directory\".  If not set, the value is \"file\".","schema":{"type":"string"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"string","format":"binary"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}},"text/plain":{"schema":{"type":"string","format":"binary"}}}},"206":{"description":"Partial content","headers":{"Accept-Ranges":{"description":"Indicates that the service supports requests for partial file content.","schema":{"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.","schema":{"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.","schema":{"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.","schema":{"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.","schema":{"type":"string"}},"Content-Length":{"description":"The size of the resource in bytes.","schema":{"type":"integer","format":"int64"}},"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.","schema":{"type":"string"}},"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.","schema":{"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.","schema":{"type":"string"}},"Date":{"description":"A UTC date/time value generated by the service that indicates the time at which the response was initiated.","schema":{"type":"string"}},"ETag":{"description":"An HTTP entity tag associated with the file or directory.","schema":{"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.","schema":{"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.","schema":{"type":"string"}},"x-ms-lease-duration":{"description":"When a resource is leased, specifies whether the lease is of infinite or fixed duration.","schema":{"type":"string"}},"x-ms-lease-state":{"description":"Lease state of the resource. ","schema":{"type":"string"}},"x-ms-lease-status":{"description":"The lease status of the resource.","schema":{"type":"string"}},"x-ms-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.","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-resource-type":{"description":"The type of the resource.  The value may be \"file\" or \"directory\".  If not set, the value is \"file\".","schema":{"type":"string"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"string","format":"binary"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}},"text/plain":{"schema":{"type":"string","format":"binary"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Read File","tags":["File and Directory Operations"]},"head":{"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://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).","operationId":"Path_GetProperties","parameters":[{"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.","in":"query","name":"action","required":false,"x-ms-enum":{"modelAsString":false,"name":"PathGetPropertiesAction"},"schema":{"type":"string","enum":["getAccessControl","getStatus","checkAccess"]}},{"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.","in":"query","name":"upn","required":false,"schema":{"type":"boolean"}},{"description":"Required only for check access action. Valid only when Hierarchical Namespace is enabled for the account. File system operation read/write/execute in string form, matching regex pattern '[rwx-]{3}'","in":"query","name":"fsAction","required":false,"schema":{"type":"string"}},{"description":"Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path.","in":"header","name":"x-ms-lease-id","required":false,"schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},{"description":"Optional.  An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}},{"description":"Optional.  An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.","in":"header","name":"If-None-Match","required":false,"schema":{"type":"string"}},{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.","in":"header","name":"If-Modified-Since","required":false,"schema":{"type":"string"}},{"description":"Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.","in":"header","name":"If-Unmodified-Since","required":false,"schema":{"type":"string"}}],"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.","schema":{"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.","schema":{"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.","schema":{"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.","schema":{"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.","schema":{"type":"string"}},"Content-Length":{"description":"The size of the resource in bytes.","schema":{"type":"integer","format":"int64"}},"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.","schema":{"type":"string"}},"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.","schema":{"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.","schema":{"type":"string"}},"Date":{"description":"A UTC date/time value generated by the service that indicates the time at which the response was initiated.","schema":{"type":"string"}},"ETag":{"description":"An HTTP entity tag associated with the file or directory.","schema":{"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.","schema":{"type":"string"}},"x-ms-acl":{"description":"The POSIX access control list for the file or directory.  Included in the response only if the action is \"getAccessControl\" and Hierarchical Namespace is enabled for the account.","schema":{"type":"string"}},"x-ms-group":{"description":"The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.","schema":{"type":"string"}},"x-ms-lease-duration":{"description":"When a resource is leased, specifies whether the lease is of infinite or fixed duration.","schema":{"type":"string"}},"x-ms-lease-state":{"description":"Lease state of the resource. ","schema":{"type":"string"}},"x-ms-lease-status":{"description":"The lease status of the resource.","schema":{"type":"string"}},"x-ms-owner":{"description":"The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.","schema":{"type":"string"}},"x-ms-permissions":{"description":"The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.","schema":{"type":"string"}},"x-ms-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.","schema":{"type":"string"}},"x-ms-request-id":{"description":"A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.","schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},"x-ms-resource-type":{"description":"The type of the resource.  The value may be \"file\" or \"directory\".  If not set, the value is \"file\".","schema":{"type":"string"}},"x-ms-version":{"description":"The version of the REST protocol used to process the request.","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Get Properties | Get Status | Get Access Control List | Check Access","tags":["File and Directory Operations"]},"parameters":[{"description":"The filesystem identifier.","in":"path","name":"filesystem","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$"}},{"description":"The file or directory path.","in":"path","name":"path","required":true,"schema":{"type":"string"}},{"description":"A UUID recorded in the analytics logs for troubleshooting and correlation.","in":"header","name":"x-ms-client-request-id","required":false,"x-ms-client-request-id":true,"schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},{"description":"An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.","in":"query","name":"timeout","required":false,"schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Specifies the Coordinated Universal Time (UTC) for the request.  This is required when using shared key authorization.","in":"header","name":"x-ms-date","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Version"}],"patch":{"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. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).","operationId":"Path_Update","parameters":[{"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, or \"setAccessControl\" to set the owner, group, permissions, or access control list for a file or directory.  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.","in":"query","name":"action","required":true,"x-ms-enum":{"modelAsString":false,"name":"PathUpdateAction"},"schema":{"type":"string","enum":["append","flush","setProperties","setAccessControl"]}},{"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.","in":"query","name":"position","required":false,"schema":{"type":"integer","format":"int64"}},{"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.","in":"query","name":"retainUncommittedData","required":false,"schema":{"type":"boolean"}},{"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.\"","in":"query","name":"close","required":false,"schema":{"type":"boolean"}},{"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\".","in":"header","name":"Content-Length","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},{"description":"Optional. An MD5 hash of the request content. This header is valid on \"Append\" and \"Flush\" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the storage service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored with the file. This header is associated with the request content, and not with the stored content of the file itself.","in":"header","name":"Content-MD5","schema":{"type":"string"}},{"description":"The lease ID must be specified if there is an active lease.","in":"header","name":"x-ms-lease-id","required":false,"schema":{"type":"string","pattern":"^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$"}},{"description":"Optional and only valid for flush and set properties operations.  The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations.","in":"header","name":"x-ms-cache-control","required":false,"schema":{"type":"string"}},{"description":"Optional and only valid for flush and set properties operations.  The service stores this value and includes it in the \"Content-Type\" response header for \"Read File\" operations.","in":"header","name":"x-ms-content-type","required":false,"schema":{"type":"string"}},{"description":"Optional and only valid for flush and set properties operations.  The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.","in":"header","name":"x-ms-content-disposition","required":false,"schema":{"type":"string"}},{"description":"Optional and only valid for flush and set properties operations.  The service stores this value and includes it in the \"Content-Encoding\" response header for \"Read File\" operations.","in":"header","name":"x-ms-content-encoding","required":false,"schema":{"type":"string"}},{"description":"Optional and only valid for flush and set properties operations.  The service stores this value and includes it in the \"Content-Language\" response header for \"Read File\" operations.","in":"header","name":"x-ms-content-language","required":false,"schema":{"type":"string"}},{"description":"Optional and only valid for \"Flush & Set Properties\" operations.  The service stores this value and includes it in the \"Content-Md5\" response header for \"Read & Get Properties\" operations. If this property is not specified on the request, then the property will be cleared for the file. Subsequent calls to \"Read & Get Properties\" will not return this property unless it is explicitly set on that file again.","in":"header","name":"x-ms-content-md5","required":false,"schema":{"type":"string"}},{"description":"Optional.  User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory 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","name":"x-ms-properties","required":false,"schema":{"type":"string"}},{"description":"Optional and valid only for the setAccessControl operation. Sets the owner of the file or directory.","in":"header","name":"x-ms-owner","required":false,"schema":{"type":"string"}},{"description":"Optional and valid only for the setAccessControl operation. Sets the owning group of the file or directory.","in":"header","name":"x-ms-group","required":false,"schema":{"type":"string"}},{"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. Invalid in conjunction with x-ms-acl.","in":"header","name":"x-ms-permissions","required":false,"schema":{"type":"string"}},{"description":"Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access control list (ACL).  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]\". The scope must be \"default\" to indicate the ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL.  There are four ACE types: \"user\" grants rights to the owner or a named user, \"group\" grants rights to the owning group or a named group, \"mask\" restricts rights granted to named users and the members of groups, and \"