Microsoft Azure File and Directory Operations API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector File and Directory Operations API
schemes:
- https
tags:
- name: File and Directory Operations
paths:
  /{filesystem}/{path}:
    parameters:
    - name: filesystem
      in: path
      description: The filesystem identifier.
      pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
      minLength: 3
      maxLength: 63
      required: true
      type: string
    - name: path
      in: path
      description: The file or directory path.
      required: true
      type: string
    - name: x-ms-client-request-id
      description: A UUID recorded in the analytics logs for troubleshooting and correlation.
      in: header
      pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
      required: false
      type: string
      x-ms-client-request-id: true
    - name: timeout
      in: query
      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
      minimum: 1
      required: false
      type: integer
    - name: x-ms-date
      in: header
      description: Specifies the Coordinated Universal Time (UTC) for the request.  This is required when using shared key authorization.
      required: false
      type: string
    - $ref: '#/parameters/Version'
    put:
      operationId: microsoftAzurePathCreate
      summary: Microsoft Azure Create File | Create Directory | Rename File | Rename Directory
      description: 'Create or rename a file or directory.    By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken.  This operation supports conditional HTTP requests.  For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).  To fail if the destination already exists, use a conditional request with If-None-Match: "*".'
      consumes:
      - application/octet-stream
      tags:
      - File and Directory Operations
      responses:
        '201':
          description: The file or directory was 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 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-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
            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
            Content-Length:
              description: The size of the resource in bytes.
              type: integer
              format: int64
        default:
          $ref: '#/responses/ErrorResponse'
      parameters:
      - name: resource
        in: query
        description: Required only for Create File and Create Directory. The value must be "file" or "directory".
        required: false
        type: string
        enum:
        - directory
        - file
        x-ms-enum:
          name: PathResourceType
          modelAsString: false
      - name: continuation
        in: query
        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.
        required: false
        type: string
      - name: mode
        in: query
        description: 'Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be "legacy" or "posix", and the default value will be "posix". '
        required: false
        type: string
        enum:
        - legacy
        - posix
        x-ms-enum:
          name: PathRenameMode
          modelAsString: false
      - name: Cache-Control
        in: header
        description: Optional.  The service stores this value and includes it in the "Cache-Control" response header for "Read File" operations for "Read File" operations.
        required: false
        type: string
      - name: Content-Encoding
        in: header
        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.
        required: false
        type: string
      - name: Content-Language
        in: header
        description: Optional.  Specifies the natural language used by the intended audience for the file.
        required: false
        type: string
      - name: Content-Disposition
        in: header
        description: Optional.  The service stores this value and includes it in the "Content-Disposition" response header for "Read File" operations.
        required: false
        type: string
      - name: x-ms-cache-control
        in: header
        description: Optional.  The service stores this value and includes it in the "Cache-Control" response header for "Read File" operations.
        required: false
        type: string
      - name: x-ms-content-type
        in: header
        description: Optional.  The service stores this value and includes it in the "Content-Type" response header for "Read File" operations.
        required: false
        type: string
      - name: x-ms-content-encoding
        in: header
        description: Optional.  The service stores this value and includes it in the "Content-Encoding" response header for "Read File" operations.
        required: false
        type: string
      - name: x-ms-content-language
        in: header
        description: Optional.  The service stores this value and includes it in the "Content-Language" response header for "Read File" operations.
        required: false
        type: string
      - name: x-ms-content-disposition
        in: header
        description: Optional.  The service stores this value and includes it in the "Content-Disposition" response header for "Read File" operations.
        required: false
        type: string
      - name: x-ms-rename-source
        in: header
        description: 'An optional file or directory to be renamed.  The value must have the following format: "/{filesystem}/{path}".  If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.'
        required: false
        type: string
      - name: x-ms-lease-id
        in: header
        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.
        pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
        required: false
        type: string
      - name: x-ms-source-lease-id
        in: header
        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.
        pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
        required: false
        type: string
      - name: x-ms-properties
        description: Optional.  User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.
        in: header
        required: false
        type: string
      - name: x-ms-permissions
        description: Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.  The sticky bit is also supported.  Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
        in: header
        required: false
        type: string
      - name: x-ms-umask
        description: Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created.  The resulting permission is given by p & ^u, where p is the permission and u is the umask.  For example, if p is 0777 and u is 0057, then the resulting permission is 0720.  The default permission is 0777 for a directory and 0666 for a file.  The default umask is 0027.  The umask must be specified in 4-digit octal notation (e.g. 0766).
        in: header
        required: false
        type: string
      - name: If-Match
        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
        required: false
        type: string
      - name: If-None-Match
        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
        required: false
        type: string
      - name: If-Modified-Since
        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
        required: false
        type: string
      - name: If-Unmodified-Since
        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
        required: false
        type: string
      - name: x-ms-source-if-match
        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
        required: false
        type: string
      - name: x-ms-source-if-none-match
        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
        required: false
        type: string
      - name: x-ms-source-if-modified-since
        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
        required: false
        type: string
      - name: x-ms-source-if-unmodified-since
        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
        required: false
        type: string
    patch:
      operationId: microsoftAzurePathUpdate
      summary: Microsoft Azure Append Data | Flush Data | Set Properties | Set Access Control
      description: Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. 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).
      consumes:
      - application/octet-stream
      - text/plain
      tags:
      - File and Directory Operations
      responses:
        '200':
          description: The data was flushed (written) to the file or the properties were set successfully.
          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
            Accept-Ranges:
              description: Indicates that the service supports requests for partial file content.
              type: string
            Cache-Control:
              description: If the Cache-Control request header has previously been set for the resource, that value is returned in this header.
              type: string
            Content-Disposition:
              description: If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.
              type: string
            Content-Encoding:
              description: If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.
              type: string
            Content-Language:
              description: If the Content-Language request header has previously been set for the resource, that value is returned in this header.
              type: string
            Content-Length:
              description: The size of the resource in bytes.
              type: integer
              format: int64
            Content-Range:
              description: Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.
              type: string
            Content-Type:
              description: The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.
              type: string
            Content-MD5:
              description: An MD5 hash of the request content. This header is only returned for "Flush" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content.
              type: string
            x-ms-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'
      parameters:
      - name: action
        in: query
        description: The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, 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.
        required: true
        type: string
        enum:
        - append
        - flush
        - setProperties
        - setAccessControl
        x-ms-enum:
          name: PathUpdateAction
          modelAsString: false
      - name: position
        in: query
        description: This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file.  It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file.  The value must be the position where the data is to be appended.  Uploaded data is not immediately flushed, or written, to the file.  To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.
        format: int64
        required: false
        type: integer
      - name: retainUncommittedData
        in: query
        description: Valid only for flush operations.  If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation.  The default is false.  Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.
        required: false
        type: boolean
      - name: close
        in: query
        description: Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
        required: false
        type: boolean
      - name: Content-Length
        in: header
        description: Required for "Append Data" and "Flush Data".  Must be 0 for "Flush Data".  Must be the length of the request content in bytes for "Append Data".
        minimum: 0
        required: false
        type: integer
        format: int64
      - name: Content-MD5
        in: header
        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.
        type: string
      - name: x-ms-lease-id
        in: header
        description: The lease ID must be specified if there is an active lease.
        pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
        required: false
        type: string
      - name: x-ms-cache-control
        in: header
        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.
        required: false
        type: string
      - name: x-ms-content-type
        in: header
        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.
        required: false
        type: string
      - name: x-ms-content-disposition
        in: header
        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.
        required: false
        type: string
      - name: x-ms-content-encoding
        in: header
        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.
        required: false
        type: string
      - name: x-ms-content-language
        in: header
        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.
        required: false
        type: string
      - name: x-ms-content-md5
        in: header
        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.
        required: false
        type: string
      - name: x-ms-properties
        description: Optional.  User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is 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
        required: false
        type: string
      - name: x-ms-owner
        description: Optional and valid only for the setAccessControl operation. Sets the owner of the file or directory.
        in: header
        required: false
        type: string
      - name: x-ms-group
        description: Optional and valid only for the setAccessControl operation. Sets the owning group of the file or directory.
        in: header
        required: false
        type: string
      - name: x-ms-permissions
        description: Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission.  The sticky bit is also supported.  Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.
        in: header
        required: false
        type: string
      - name: x-ms-acl
        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
        required: false
        type: string
      - name: If-Match
        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
        required: false
        type: string
      - name: If-None-Match
        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
        required: false
        type: string
      - name: If-Modified-Since
        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
        required: false
        type: string
      - name: If-Unmodified-Since
        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
        required: false
        type: string
      - name: requestBody
        description: Valid only for append operations.  The data to be uploaded and appended to the file.
        in: body
        required: false
        schema:
          type: object
          format: file
    post:
      operationId: microsoftAzurePathLease
      summary: Microsoft Azure Lease Path
      description: Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests.  For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
      tags:
      - File and Directory Operations
      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-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
            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
        '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-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
            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
        '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-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}

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-file-and-directory-operations-api-openapi.yml