{
  "opencollection": "1.0.0",
  "info": {
    "name": "Microsoft Azure AccessControlClient AccessConnector File and Directory Operations API",
    "version": "2020-08-01-preview"
  },
  "items": [
    {
      "info": {
        "name": "File and Directory Operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Azure Read File",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/:filesystem/:path",
            "headers": [
              {
                "name": "x-ms-client-request-id",
                "value": ""
              },
              {
                "name": "x-ms-date",
                "value": ""
              },
              {
                "name": "x-ms-version",
                "value": ""
              },
              {
                "name": "Range",
                "value": ""
              },
              {
                "name": "x-ms-lease-id",
                "value": ""
              },
              {
                "name": "x-ms-range-get-content-md5",
                "value": ""
              },
              {
                "name": "If-Match",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              },
              {
                "name": "If-Modified-Since",
                "value": ""
              },
              {
                "name": "If-Unmodified-Since",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "filesystem",
                "value": "",
                "type": "path",
                "description": "The filesystem identifier."
              },
              {
                "name": "path",
                "value": "",
                "type": "path",
                "description": "The file or directory path."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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)."
        },
        {
          "info": {
            "name": "Microsoft Azure Lease Path",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/:filesystem/:path",
            "headers": [
              {
                "name": "x-ms-client-request-id",
                "value": ""
              },
              {
                "name": "x-ms-date",
                "value": ""
              },
              {
                "name": "x-ms-version",
                "value": ""
              },
              {
                "name": "x-ms-lease-action",
                "value": ""
              },
              {
                "name": "x-ms-lease-duration",
                "value": ""
              },
              {
                "name": "x-ms-lease-break-period",
                "value": ""
              },
              {
                "name": "x-ms-lease-id",
                "value": ""
              },
              {
                "name": "x-ms-proposed-lease-id",
                "value": ""
              },
              {
                "name": "If-Match",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              },
              {
                "name": "If-Modified-Since",
                "value": ""
              },
              {
                "name": "If-Unmodified-Since",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "filesystem",
                "value": "",
                "type": "path",
                "description": "The filesystem identifier."
              },
              {
                "name": "path",
                "value": "",
                "type": "path",
                "description": "The file or directory path."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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)."
        },
        {
          "info": {
            "name": "Microsoft Azure Create File | Create Directory | Rename File | Rename Directory",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/:filesystem/:path",
            "headers": [
              {
                "name": "x-ms-client-request-id",
                "value": ""
              },
              {
                "name": "x-ms-date",
                "value": ""
              },
              {
                "name": "x-ms-version",
                "value": ""
              },
              {
                "name": "Cache-Control",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Content-Language",
                "value": ""
              },
              {
                "name": "Content-Disposition",
                "value": ""
              },
              {
                "name": "x-ms-cache-control",
                "value": ""
              },
              {
                "name": "x-ms-content-type",
                "value": ""
              },
              {
                "name": "x-ms-content-encoding",
                "value": ""
              },
              {
                "name": "x-ms-content-language",
                "value": ""
              },
              {
                "name": "x-ms-content-disposition",
                "value": ""
              },
              {
                "name": "x-ms-rename-source",
                "value": ""
              },
              {
                "name": "x-ms-lease-id",
                "value": ""
              },
              {
                "name": "x-ms-source-lease-id",
                "value": ""
              },
              {
                "name": "x-ms-properties",
                "value": ""
              },
              {
                "name": "x-ms-permissions",
                "value": ""
              },
              {
                "name": "x-ms-umask",
                "value": ""
              },
              {
                "name": "If-Match",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              },
              {
                "name": "If-Modified-Since",
                "value": ""
              },
              {
                "name": "If-Unmodified-Since",
                "value": ""
              },
              {
                "name": "x-ms-source-if-match",
                "value": ""
              },
              {
                "name": "x-ms-source-if-none-match",
                "value": ""
              },
              {
                "name": "x-ms-source-if-modified-since",
                "value": ""
              },
              {
                "name": "x-ms-source-if-unmodified-since",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "filesystem",
                "value": "",
                "type": "path",
                "description": "The filesystem identifier."
              },
              {
                "name": "path",
                "value": "",
                "type": "path",
                "description": "The file or directory path."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "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."
              },
              {
                "name": "resource",
                "value": "",
                "type": "query",
                "description": "Required only for Create File and Create Directory. The value must be \"file\" or \"directory\"."
              },
              {
                "name": "continuation",
                "value": "",
                "type": "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."
              },
              {
                "name": "mode",
                "value": "",
                "type": "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\". "
              }
            ]
          },
          "docs": "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"
        },
        {
          "info": {
            "name": "Microsoft Azure Append Data | Flush Data | Set Properties | Set Access Control",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/:filesystem/:path",
            "headers": [
              {
                "name": "x-ms-client-request-id",
                "value": ""
              },
              {
                "name": "x-ms-date",
                "value": ""
              },
              {
                "name": "x-ms-version",
                "value": ""
              },
              {
                "name": "Content-Length",
                "value": ""
              },
              {
                "name": "Content-MD5",
                "value": ""
              },
              {
                "name": "x-ms-lease-id",
                "value": ""
              },
              {
                "name": "x-ms-cache-control",
                "value": ""
              },
              {
                "name": "x-ms-content-type",
                "value": ""
              },
              {
                "name": "x-ms-content-disposition",
                "value": ""
              },
              {
                "name": "x-ms-content-encoding",
                "value": ""
              },
              {
                "name": "x-ms-content-language",
                "value": ""
              },
              {
                "name": "x-ms-content-md5",
                "value": ""
              },
              {
                "name": "x-ms-properties",
                "value": ""
              },
              {
                "name": "x-ms-owner",
                "value": ""
              },
              {
                "name": "x-ms-group",
                "value": ""
              },
              {
                "name": "x-ms-permissions",
                "value": ""
              },
              {
                "name": "x-ms-acl",
                "value": ""
              },
              {
                "name": "If-Match",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              },
              {
                "name": "If-Modified-Since",
                "value": ""
              },
              {
                "name": "If-Unmodified-Since",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "filesystem",
                "value": "",
                "type": "path",
                "description": "The filesystem identifier."
              },
              {
                "name": "path",
                "value": "",
                "type": "path",
                "description": "The file or directory path."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "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."
              },
              {
                "name": "action",
                "value": "",
                "type": "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."
              },
              {
                "name": "position",
                "value": "",
                "type": "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."
              },
              {
                "name": "retainUncommittedData",
                "value": "",
                "type": "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."
              },
              {
                "name": "close",
                "value": "",
                "type": "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.\""
              }
            ]
          },
          "docs": "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)."
        },
        {
          "info": {
            "name": "Microsoft Azure Delete File | Delete Directory",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/:filesystem/:path",
            "headers": [
              {
                "name": "x-ms-client-request-id",
                "value": ""
              },
              {
                "name": "x-ms-date",
                "value": ""
              },
              {
                "name": "x-ms-version",
                "value": ""
              },
              {
                "name": "x-ms-lease-id",
                "value": ""
              },
              {
                "name": "If-Match",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              },
              {
                "name": "If-Modified-Since",
                "value": ""
              },
              {
                "name": "If-Unmodified-Since",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "filesystem",
                "value": "",
                "type": "path",
                "description": "The filesystem identifier."
              },
              {
                "name": "path",
                "value": "",
                "type": "path",
                "description": "The file or directory path."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "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."
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "continuation",
                "value": "",
                "type": "query",
                "description": "Optional.  When deleting a directory, the number of paths that are deleted with each invocation is limited.  If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header.  When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory."
              }
            ]
          },
          "docs": "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)."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Properties | Get Status | Get Access Control List | Check Access",
            "type": "http"
          },
          "http": {
            "method": "HEAD",
            "url": "{{baseUrl}}/:filesystem/:path",
            "headers": [
              {
                "name": "x-ms-client-request-id",
                "value": ""
              },
              {
                "name": "x-ms-date",
                "value": ""
              },
              {
                "name": "x-ms-version",
                "value": ""
              },
              {
                "name": "x-ms-lease-id",
                "value": ""
              },
              {
                "name": "If-Match",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              },
              {
                "name": "If-Modified-Since",
                "value": ""
              },
              {
                "name": "If-Unmodified-Since",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "filesystem",
                "value": "",
                "type": "path",
                "description": "The filesystem identifier."
              },
              {
                "name": "path",
                "value": "",
                "type": "path",
                "description": "The file or directory path."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "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."
              },
              {
                "name": "action",
                "value": "",
                "type": "query",
                "description": "Optional. If the value is \"getStatus\" only the system defined properties for the path are returned. If the value is \"getAccessControl\" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned."
              },
              {
                "name": "upn",
                "value": "",
                "type": "query",
                "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names.  If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names."
              },
              {
                "name": "fsAction",
                "value": "",
                "type": "query",
                "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}'"
              }
            ]
          },
          "docs": "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)."
        }
      ]
    }
  ],
  "bundled": true
}