swagger: "2.0"
schemes:
  - https
host: azure.local
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://api.apis.guru/v2/cache/logo/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
produces:
  - application/json
parameters:
  Version:
    description: Specifies the version of the REST protocol used for processing the request. This is required when using shared key authorization.
    in: header
    name: x-ms-version
    required: false
    type: string
    x-ms-parameter-location: client
  accountName:
    description: The Azure Storage account name.
    in: path
    name: accountName
    required: true
    type: string
    x-ms-parameter-location: client
    x-ms-skip-url-encoding: true
  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-parameter-location: client
    x-ms-skip-url-encoding: true
responses:
  ErrorResponse:
    description: |-
      An error occurred. The possible HTTP status, code, and message strings are listed below:
      * 400 Bad Request, ContentLengthMustBeZero, "The Content-Length request header must be zero."
      * 400 Bad Request, InvalidAuthenticationInfo, "Authentication information is not given in the correct format. Check the value of Authorization header."
      * 400 Bad Request, InvalidFlushPosition, "The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data."
      * 400 Bad Request, InvalidHeaderValue, "The value for one of the HTTP headers is not in the correct format."
      * 400 Bad Request, InvalidHttpVerb, "The HTTP verb specified is invalid - it is not recognized by the server."
      * 400 Bad Request, InvalidInput, "One of the request inputs is not valid."
      * 400 Bad Request, InvalidPropertyName, "A property name cannot be empty."
      * 400 Bad Request, InvalidPropertyName, "The property name contains invalid characters."
      * 400 Bad Request, InvalidQueryParameterValue, "Value for one of the query parameters specified in the request URI is invalid."
      * 400 Bad Request, InvalidResourceName, "The specified resource name contains invalid characters."
      * 400 Bad Request, InvalidSourceUri, "The source URI is invalid."
      * 400 Bad Request, InvalidUri, "The request URI is invalid."
      * 400 Bad Request, MissingRequiredHeader, "An HTTP header that's mandatory for this request is not specified."
      * 400 Bad Request, MissingRequiredQueryParameter, "A query parameter that's mandatory for this request is not specified."
      * 400 Bad Request, MultipleConditionHeadersNotSupported, "Multiple condition headers are not supported."
      * 400 Bad Request, OutOfRangeInput, "One of the request inputs is out of range."
      * 400 Bad Request, OutOfRangeQueryParameterValue, "One of the query parameters specified in the request URI is outside the permissible range."
      * 400 Bad Request, UnsupportedHeader, "One of the headers specified in the request is not supported."
      * 400 Bad Request, UnsupportedQueryParameter, "One of the query parameters specified in the request URI is not supported."
      * 400 Bad Request, UnsupportedRestVersion, "The specified Rest Version is Unsupported."
      * 403 Forbidden, AccountIsDisabled, "The specified account is disabled."
      * 403 Forbidden, AuthorizationFailure, "This request is not authorized to perform this operation."
      * 403 Forbidden, InsufficientAccountPermissions, "The account being accessed does not have sufficient permissions to execute this operation."
      * 404 Not Found, FilesystemNotFound, "The specified filesystem does not exist."
      * 404 Not Found, PathNotFound, "The specified path does not exist."
      * 404 Not Found, RenameDestinationParentPathNotFound, "The parent directory of the destination path does not exist."
      * 404 Not Found, ResourceNotFound, "The specified resource does not exist."
      * 404 Not Found, SourcePathNotFound, "The source path for a rename operation does not exist."
      * 405 Method Not Allowed, UnsupportedHttpVerb, "The resource doesn't support the specified HTTP verb."
      * 409 Conflict, DestinationPathIsBeingDeleted, "The specified destination path is marked to be deleted."
      * 409 Conflict, DirectoryNotEmpty, "The recursive query parameter value must be true to delete a non-empty directory."
      * 409 Conflict, FilesystemAlreadyExists, "The specified filesystem already exists."
      * 409 Conflict, FilesystemBeingDeleted, "The specified filesystem is being deleted."
      * 409 Conflict, InvalidDestinationPath, "The specified path, or an element of the path, exists and its resource type is invalid for this operation."* 409 Conflict, InvalidFlushOperation, "The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API."
      * 409 Conflict, InvalidRenameSourcePath, "The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory."
      * 409 Conflict, InvalidSourceOrDestinationResourceType, "The source and destination resource type must be identical."
      * 409 Conflict, LeaseAlreadyPresent, "There is already a lease present."
      * 409 Conflict, LeaseIdMismatchWithLeaseOperation, "The lease ID specified did not match the lease ID for the resource with the specified lease operation."
      * 409 Conflict, LeaseIsAlreadyBroken, "The lease has already been broken and cannot be broken again."
      * 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken."
      * 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "The lease ID matched, but the lease is currently in breaking state and cannot be changed."
      * 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "The lease ID matched, but the lease has been broken explicitly and cannot be renewed."
      * 409 Conflict, LeaseNameMismatch, "The lease name specified did not match the existing lease name."
      * 409 Conflict, LeaseNotPresentWithLeaseOperation, "The lease ID is not present with the specified lease operation."
      * 409 Conflict, PathAlreadyExists, "The specified path already exists."
      * 409 Conflict, PathConflict, "The specified path, or an element of the path, exists and its resource type is invalid for this operation."
      * 409 Conflict, SourcePathIsBeingDeleted, "The specified source path is marked to be deleted."
      * 409 Conflict, ResourceTypeMismatch, "The resource type specified in the request does not match the type of the resource."
      * 412 Precondition Failed, ConditionNotMet, "The condition specified using HTTP conditional header(s) is not met."
      * 412 Precondition Failed, LeaseIdMismatch, "The lease ID specified did not match the lease ID for the resource."
      * 412 Precondition Failed, LeaseIdMissing, "There is currently a lease on the resource and no lease ID was specified in the request."
      * 412 Precondition Failed, LeaseNotPresent, "There is currently no lease on the resource."
      * 412 Precondition Failed, LeaseLost, "A lease ID was specified, but the lease for the resource has expired."
      * 412 Precondition Failed, SourceConditionNotMet, "The source condition specified using HTTP conditional header(s) is not met."
      * 413 Request Entity Too Large, RequestBodyTooLarge, "The request body is too large and exceeds the maximum permissible limit."
      * 416 Requested Range Not Satisfiable, InvalidRange, "The range specified is invalid for the current size of the resource."
      * 500 Internal Server Error, InternalError, "The server encountered an internal error. Please retry the request."
      * 500 Internal Server Error, OperationTimedOut, "The operation could not be completed within the permitted time."
      * 503 Service Unavailable, ServerBusy, "Egress is over the account limit."
      * 503 Service Unavailable, ServerBusy, "Ingress is over the account limit."
      * 503 Service Unavailable, ServerBusy, "Operations per second is over the account limit."
      * 503 Service Unavailable, ServerBusy, "The server is currently unable to receive requests. Please retry your request."
    headers:
      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
      x-ms-version:
        description: The version of the REST protocol used to process the request.
        type: string
    schema:
      $ref: "#/definitions/DataLakeStorageError"
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.
          enum:
            - account
          in: query
          name: resource
          required: true
          type: string
          x-ms-enum:
            modelAsString: false
            name: AccountResourceType
        - description: Filters results to filesystems within the specified prefix.
          in: query
          name: prefix
          required: false
          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
          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.
          format: int32
          in: query
          minimum: 1
          name: maxResults
          required: false
          type: integer
        - description: A UUID recorded in the analytics logs for troubleshooting and correlation.
          in: header
          name: x-ms-client-request-id
          pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
          required: false
          type: string
          x-ms-client-request-id: true
        - 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.
          format: int32
          in: query
          minimum: 1
          name: timeout
          required: false
          type: integer
        - 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
          type: string
        - $ref: "#/parameters/Version"
      responses:
        "200":
          description: OK
          headers:
            Content-Type:
              description: The content type of list filesystem response. The default content type is application/json.
              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
            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.
              type: string
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
          schema:
            $ref: "#/definitions/FilesystemList"
        default:
          $ref: "#/responses/ErrorResponse"
      summary: List Filesystems
      tags:
        - Account Operations
      x-ms-pageable:
        itemName: filesystems
        nextLinkName: null
  "/{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
          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
          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.
              type: string
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        default:
          $ref: "#/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
          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
          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
          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.
          format: int32
          in: query
          minimum: 1
          name: maxResults
          required: false
          type: integer
        - 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
          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.
              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.
              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.
              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.
              type: string
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
          schema:
            $ref: "#/definitions/PathList"
        default:
          $ref: "#/responses/ErrorResponse"
      summary: List Paths
      tags:
        - Filesystem Operations
      x-ms-pageable:
        itemName: paths
        nextLinkName: null
    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.
              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.
              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.
              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.  '
              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.
              type: string
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        default:
          $ref: "#/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
        maxLength: 63
        minLength: 3
        name: filesystem
        pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
        required: true
        type: string
      - description: The value must be "filesystem" for all filesystem operations.
        enum:
          - filesystem
        in: query
        name: resource
        required: true
        type: string
        x-ms-enum:
          modelAsString: false
          name: FilesystemResourceType
      - description: A UUID recorded in the analytics logs for troubleshooting and correlation.
        in: header
        name: x-ms-client-request-id
        pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
        required: false
        type: string
        x-ms-client-request-id: true
      - 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.
        format: int32
        in: query
        minimum: 1
        name: timeout
        required: false
        type: integer
      - 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
        type: string
      - $ref: "#/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
          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
          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
          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.
              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.
              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.
              type: string
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        default:
          $ref: "#/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
          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.
              type: string
            ETag:
              description: An HTTP entity tag associated with the filesystem.
              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.
              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.  '
              type: string
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        default:
          $ref: "#/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
          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
          type: string
        - description: The lease ID must be specified if there is an active lease.
          in: header
          name: x-ms-lease-id
          pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
          required: false
          type: string
        - 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
          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
          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
          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
          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.
              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.
              type: string
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        default:
          $ref: "#/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
          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
          pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
          required: false
          type: string
        - 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
          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
          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
          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
          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
          type: string
      produces:
        - application/json
        - application/octet-stream
        - text/plain
      responses:
        "200":
          description: Ok
          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.
              format: int64
              type: integer
            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
            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
            Date:
              description: A UTC date/time value generated by the service that indicates the time at which the response was initiated.
              type: string
            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.
              type: string
            x-ms-lease-duration:
              description: When a resource is leased, specifies whether the lease is of infinite or fixed duration.
              type: string
            x-ms-lease-state:
              description: "Lease state of the resource. "
              type: string
            x-ms-lease-status:
              description: The lease status of the resource.
              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.
              type: string
            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
            x-ms-resource-type:
              description: The type of the resource.  The value may be "file" or "directory".  If not set, the value is "file".
              type: string
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
          schema:
            type: 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.
              format: int64
              type: integer
            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
            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
            Date:
              description: A UTC date/time value generated by the service that indicates the time at which the response was initiated.
              type: string
            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.
              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
            x-ms-lease-duration:
              description: When a resource is leased, specifies whether the lease is of infinite or fixed duration.
              type: string
            x-ms-lease-state:
              description: "Lease state of the resource. "
              type: string
            x-ms-lease-status:
              description: The lease status of the resource.
              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.
              type: string
            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
            x-ms-resource-type:
              description: The type of the resource.  The value may be "file" or "directory".  If not set, the value is "file".
              type: string
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
          schema:
            type: file
        default:
          $ref: "#/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.
          enum:
            - getAccessControl
            - getStatus
            - checkAccess
          in: query
          name: action
          required: false
          type: string
          x-ms-enum:
            modelAsString: false
            name: PathGetPropertiesAction
        - 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
          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
          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
          pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
          required: false
          type: string
        - 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
          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
          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
          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
          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.
              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.
              format: int64
              type: integer
            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
            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
            Date:
              description: A UTC date/time value generated by the service that indicates the time at which the response was initiated.
              type: string
            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.
              type: string
            x-ms-acl:
              description: The POSIX access control list for the file or directory.  Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account.
              type: string
            x-ms-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-lease-duration:
              description: When a resource is leased, specifies whether the lease is of infinite or fixed duration.
              type: string
            x-ms-lease-state:
              description: "Lease state of the resource. "
              type: string
            x-ms-lease-status:
              description: The lease status of the resource.
              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.
              type: string
            x-ms-permissions:
              description: The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.
              type: string
            x-ms-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-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
            x-ms-resource-type:
              description: The type of the resource.  The value may be "file" or "directory".  If not set, the value is "file".
              type: string
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        default:
          $ref: "#/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
        maxLength: 63
        minLength: 3
        name: filesystem
        pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
        required: true
        type: string
      - description: The file or directory path.
        in: path
        name: path
        required: true
        type: string
      - description: A UUID recorded in the analytics logs for troubleshooting and correlation.
        in: header
        name: x-ms-client-request-id
        pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
        required: false
        type: string
        x-ms-client-request-id: true
      - 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.
        format: int32
        in: query
        minimum: 1
        name: timeout
        required: false
        type: integer
      - 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
        type: string
      - $ref: "#/parameters/Version"
    patch:
      consumes:
        - application/octet-stream
        - text/plain
      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.
          enum:
            - append
            - flush
            - setProperties
            - setAccessControl
          in: query
          name: action
          required: true
          type: string
          x-ms-enum:
            modelAsString: false
            name: PathUpdateAction
        - 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
          in: query
          name: position
          required: false
          type: integer
        - 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
          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
          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".
          format: int64
          in: header
          minimum: 0
          name: Content-Length
          required: false
          type: integer
        - 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
          type: string
        - description: The lease ID must be specified if there is an active lease.
          in: header
          name: x-ms-lease-id
          pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
          required: false
          type: string
        - 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
          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
          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
          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
          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
          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
          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
          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
          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
          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
          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 \"other\" grants rights to all users not found in any of the other entries. The user or group identifier is omitted for entries of type \"mask\" and \"other\".  The user or group identifier is also omitted for the owner and owning group.  The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission.  If access is not granted, the '-' character is used to denote that the permission is denied. For example, the following ACL grants read, write, and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else: \"user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx\". Invalid in conjunction with x-ms-permissions."
          in: header
          name: x-ms-acl
          required: false
          type: string
        - description: Optional for Flush Data and Set Properties, but invalid for Append Data.  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
          type: string
        - description: Optional for Flush Data and Set Properties, but invalid for Append Data.  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
          type: string
        - description: Optional for Flush Data and Set Properties, but invalid for Append Data. 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
          type: string
        - description: Optional for Flush Data and Set Properties, but invalid for Append Data. 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
          type: string
        - description: Valid only for append operations.  The data to be uploaded and appended to the file.
          in: body
          name: requestBody
          required: false
          schema:
            format: file
            type: object
      responses:
        "200":
          description: The data was flushed (written) to the file or the properties were set successfully.
          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.
              format: int64
              type: integer
            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
            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
            Date:
              description: A UTC date/time value generated by the service that indicates the time at which the response was initiated.
              type: string
            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.
              type: string
            x-ms-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-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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        "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
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        default:
          $ref: "#/responses/ErrorResponse"
      summary: Append Data | Flush Data | Set Properties | Set Access Control
      tags:
        - File and Directory Operations
    post:
      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://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
      operationId: Path_Lease
      parameters:
        - 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.'
          enum:
            - acquire
            - break
            - change
            - renew
            - release
          in: header
          name: x-ms-lease-action
          required: true
          type: string
          x-ms-enum:
            modelAsString: false
            name: PathLeaseAction
        - 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
          in: header
          name: x-ms-lease-duration
          required: false
          type: integer
        - 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
          in: header
          name: x-ms-lease-break-period
          required: false
          type: integer
        - description: Required when "x-ms-lease-action" is "renew", "change" or "release". For the renew and release actions, this must match the current lease ID.
          in: header
          name: x-ms-lease-id
          pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
          required: false
          type: string
        - description: Required when "x-ms-lease-action" is "acquire" or "change".  A lease will be acquired with this lease ID if the operation is successful.
          in: header
          name: x-ms-proposed-lease-id
          pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
          required: false
          type: string
        - 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
          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
          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
          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
          type: string
      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
            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.
              type: string
            x-ms-lease-id:
              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
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        "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
            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.
              type: string
            x-ms-lease-id:
              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
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        "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.
              type: string
            x-ms-lease-time:
              description: The time remaining in the lease period in seconds.
              type: string
            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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        default:
          $ref: "#/responses/ErrorResponse"
      summary: Lease Path
      tags:
        - File and Directory Operations
    put:
      consumes:
        - application/octet-stream
      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://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).  To fail if the destination already exists, use a conditional request with If-None-Match: "*".'
      operationId: Path_Create
      parameters:
        - description: Required only for Create File and Create Directory. The value must be "file" or "directory".
          enum:
            - directory
            - file
          in: query
          name: resource
          required: false
          type: string
          x-ms-enum:
            modelAsString: false
            name: PathResourceType
        - description: Optional.  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.
          in: query
          name: continuation
          required: false
          type: string
        - 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". '
          enum:
            - legacy
            - posix
          in: query
          name: mode
          required: false
          type: string
          x-ms-enum:
            modelAsString: false
            name: PathRenameMode
        - description: Optional.  The service stores this value and includes it in the "Cache-Control" response header for "Read File" operations for "Read File" operations.
          in: header
          name: Cache-Control
          required: false
          type: string
        - description: Optional.  Specifies which content encodings have been applied to the file. This value is returned to the client when the "Read File" operation is performed.
          in: header
          name: Content-Encoding
          required: false
          type: string
        - description: Optional.  Specifies the natural language used by the intended audience for the file.
          in: header
          name: Content-Language
          required: false
          type: string
        - description: Optional.  The service stores this value and includes it in the "Content-Disposition" response header for "Read File" operations.
          in: header
          name: Content-Disposition
          required: false
          type: string
        - description: Optional.  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
          type: string
        - description: Optional.  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
          type: string
        - description: Optional.  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
          type: string
        - description: Optional.  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
          type: string
        - description: Optional.  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
          type: string
        - 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.'
          in: header
          name: x-ms-rename-source
          required: false
          type: string
        - description: Optional.  A lease ID for the path specified in the URI.  The path to be overwritten must have an active lease and the lease ID must match.
          in: header
          name: x-ms-lease-id
          pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
          required: false
          type: string
        - description: Optional for rename operations.  A lease ID for the source path.  The source path must have an active lease and the lease ID must match.
          in: header
          name: x-ms-source-lease-id
          pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
          required: false
          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.
          in: header
          name: x-ms-properties
          required: false
          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.
          in: header
          name: x-ms-permissions
          required: false
          type: string
        - 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 & ^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
          name: x-ms-umask
          required: false
          type: string
        - 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
          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
          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
          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
          type: string
        - description: Optional.  An ETag value. Specify this header to perform the rename operation only if the source's ETag matches the value specified. The ETag must be specified in quotes.
          in: header
          name: x-ms-source-if-match
          required: false
          type: string
        - description: Optional.  An ETag value or the special wildcard ("*") value. Specify this header to perform the rename operation only if the source's ETag does not match the value specified. The ETag must be specified in quotes.
          in: header
          name: x-ms-source-if-none-match
          required: false
          type: string
        - description: Optional. A date and time value. Specify this header to perform the rename operation only if the source has been modified since the specified date and time.
          in: header
          name: x-ms-source-if-modified-since
          required: false
          type: string
        - description: Optional. A date and time value. Specify this header to perform the rename operation only if the source has not been modified since the specified date and time.
          in: header
          name: x-ms-source-if-unmodified-since
          required: false
          type: string
      responses:
        "201":
          description: The file or directory was created.
          headers:
            Content-Length:
              description: The size of the resource in bytes.
              format: int64
              type: integer
            Date:
              description: A UTC date/time value generated by the service that indicates the time at which the response was initiated.
              type: string
            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.
              type: string
            x-ms-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-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
            x-ms-version:
              description: The version of the REST protocol used to process the request.
              type: string
        default:
          $ref: "#/responses/ErrorResponse"
      summary: Create File | Create Directory | Rename File | Rename Directory
      tags:
        - File and Directory Operations
definitions:
  DataLakeStorageError:
    properties:
      error:
        description: The service error response object.
        properties:
          code:
            description: The service error code.
            type: string
          message:
            description: The service error message.
            type: string
  Filesystem:
    properties:
      eTag:
        type: string
      lastModified:
        type: string
      name:
        type: string
  FilesystemList:
    properties:
      filesystems:
        items:
          $ref: "#/definitions/Filesystem"
        type: array
  Path:
    properties:
      contentLength:
        format: int64
        type: integer
      eTag:
        type: string
      group:
        type: string
      isDirectory:
        default: false
        type: boolean
      lastModified:
        type: string
      name:
        type: string
      owner:
        type: string
      permissions:
        type: string
  PathList:
    properties:
      paths:
        items:
          $ref: "#/definitions/Path"
        type: array
x-ms-parameterized-host:
  hostTemplate: "{accountName}.{dnsSuffix}"
  parameters:
    - $ref: "#/parameters/accountName"
    - $ref: "#/parameters/dnsSuffix"
