diff --git a/samples/AppConfiguration/readme.md b/samples/AppConfiguration/readme.md
index 85ab7626..11ac41a3 100644
--- a/samples/AppConfiguration/readme.md
+++ b/samples/AppConfiguration/readme.md
@@ -6,5 +6,5 @@
title: AppConfiguration
require: $(this-folder)/../readme.samples.md
input-file: appconfiguration.json
-namespace: Microsoft.Azure.AppConfiguration
+namespace: Azure.AppConfiguration
```
\ No newline at end of file
diff --git a/samples/Billing/readme.md b/samples/Billing/readme.md
index 0fa4b4d7..b00c9e24 100644
--- a/samples/Billing/readme.md
+++ b/samples/Billing/readme.md
@@ -10,5 +10,5 @@ require:
- https://github.com/Azure/azure-rest-api-specs/blob/resource-hybrid-profile/specification/commerce/resource-manager/readme.md
- https://github.com/Azure/azure-rest-api-specs/blob/resource-hybrid-profile/specification/consumption/resource-manager/readme.md
profile: latest-2019-04-30
-namespace: Microsoft.Azure.Billing
+namespace: Azure.Billing
```
\ No newline at end of file
diff --git a/samples/Dns/readme.md b/samples/Dns/readme.md
index 116432c4..ce4078e8 100644
--- a/samples/Dns/readme.md
+++ b/samples/Dns/readme.md
@@ -8,5 +8,5 @@ require:
- $(this-folder)/../readme.samples.md
- https://github.com/Azure/azure-rest-api-specs/blob/resource-hybrid-profile/specification/dns/resource-manager/readme.md
profile: latest-2019-04-30
-namespace: Microsoft.Azure.Dns
+namespace: Azure.Dns
```
\ No newline at end of file
diff --git a/samples/KeyVault/readme.md b/samples/KeyVault/readme.md
index 094e3837..2e63fbb5 100644
--- a/samples/KeyVault/readme.md
+++ b/samples/KeyVault/readme.md
@@ -6,5 +6,5 @@
title: KeyVault
require: $(this-folder)/../readme.samples.md
input-file: keyvault.json
-namespace: Microsoft.Azure.KeyVault
+namespace: Azure.KeyVault
```
\ No newline at end of file
diff --git a/samples/Media/readme.md b/samples/Media/readme.md
index e9df26b4..cff2c13e 100644
--- a/samples/Media/readme.md
+++ b/samples/Media/readme.md
@@ -8,5 +8,5 @@ require:
- $(this-folder)/../readme.samples.md
- https://github.com/Azure/azure-rest-api-specs/blob/resource-hybrid-profile/specification/mediaservices/resource-manager/readme.md
profile: latest-2019-04-30
-namespace: Microsoft.Azure.Media
+namespace: Azure.Media
```
\ No newline at end of file
diff --git a/samples/Redis/readme.md b/samples/Redis/readme.md
index fc609d04..a288912d 100644
--- a/samples/Redis/readme.md
+++ b/samples/Redis/readme.md
@@ -6,5 +6,5 @@
title: Redis
require: $(this-folder)/../readme.samples.md
input-file: redis.json
-namespace: Microsoft.Azure.Redis
+namespace: Azure.Redis
```
\ No newline at end of file
diff --git a/samples/Storage.Blobs/blob-service.json b/samples/Storage.Blobs/blob-service.json
new file mode 100644
index 00000000..46353db5
--- /dev/null
+++ b/samples/Storage.Blobs/blob-service.json
@@ -0,0 +1,10160 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Azure Blob Storage",
+ "version": "2019-07-07",
+ "x-ms-code-generation-settings": {
+ "header": "MIT",
+ "strictSpecAdherence": false
+ }
+ },
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{url}",
+ "useSchemePrefix": false,
+ "positionInOperation": "first",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Url"
+ }
+ ]
+ },
+ "securityDefinitions": {
+ "blob_shared_key": {
+ "type": "apiKey",
+ "name": "Authorization",
+ "in": "header"
+ }
+ },
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/xml",
+ "application/octet-stream",
+ "text/plain"
+ ],
+ "produces": [
+ "application/xml",
+ "application/octet-stream",
+ "text/plain"
+ ],
+ "paths": {},
+ "x-ms-paths": {
+ "/?restype=service&comp=properties": {
+ "put": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_SetProperties",
+ "description": "Sets properties for a storage account's Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules",
+ "parameters": [
+ {
+ "$ref": "#/parameters/StorageServiceProperties"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Success (Accepted)",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_GetProperties",
+ "description": "gets the properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageServiceProperties"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "service"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/?restype=service&comp=stats": {
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_GetStatistics",
+ "description": "Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageServiceStats"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "service"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "stats"
+ ]
+ }
+ ]
+ },
+ "/?comp=list": {
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_ListContainersSegment",
+ "description": "The List Containers Segment operation returns a list of the containers under the specified account",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Prefix"
+ },
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/MaxResults"
+ },
+ {
+ "$ref": "#/parameters/ListContainersInclude"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/ListContainersSegmentResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "NextMarker"
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "list"
+ ]
+ }
+ ]
+ },
+ "/?restype=service&comp=userdelegationkey": {
+ "post": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_GetUserDelegationKey",
+ "description": "Retrieves a user delgation key for the Blob service. This is only a valid operation when using bearer token authentication.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/KeyInfo"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/UserDelegationKey"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "service"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "userdelegationkey"
+ ]
+ }
+ ]
+ },
+ "/?restype=account&comp=properties": {
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_GetAccountInfo",
+ "description": "Returns the sku name and account kind ",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success (OK)",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-sku-name": {
+ "x-ms-client-name": "SkuName",
+ "type": "string",
+ "enum": [
+ "Standard_LRS",
+ "Standard_GRS",
+ "Standard_RAGRS",
+ "Standard_ZRS",
+ "Premium_LRS"
+ ],
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": false
+ },
+ "description": "Identifies the sku name of the account"
+ },
+ "x-ms-account-kind": {
+ "x-ms-client-name": "AccountKind",
+ "type": "string",
+ "enum": [
+ "Storage",
+ "BlobStorage",
+ "StorageV2"
+ ],
+ "x-ms-enum": {
+ "name": "AccountKind",
+ "modelAsString": false
+ },
+ "description": "Identifies the account kind"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "account"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/?comp=blobs": {
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_FilterBlobs",
+ "description": "The Filter Blobs operation enables callers to list blobs in an account whose tags match a given search expression.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/MaxResults"
+ },
+ {
+ "$ref": "#/parameters/BlobTagFilter"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "Content-Type": {
+ "type": "string",
+ "description": "The media type of the body of the response. For Filter Blobs this is 'application/xml'"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/FilterBlobsResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "blobs"
+ ]
+ }
+ ]
+ },
+ "/{containerName}?restype=container": {
+ "put": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_Create",
+ "description": "creates a new container under the specified account. If the container with the same name already exists, the operation fails",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/BlobPublicAccess"
+ },
+ {
+ "$ref": "#/parameters/DefaultEncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/DenyEncryptionScopeOverride"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success, Container created.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_GetProperties",
+ "description": "returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "x-ms-meta": {
+ "type": "string",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-lease-duration": {
+ "x-ms-client-name": "LeaseDuration",
+ "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.",
+ "type": "string",
+ "enum": [
+ "infinite",
+ "fixed"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseDurationType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-state": {
+ "x-ms-client-name": "LeaseState",
+ "description": "Lease state of the blob.",
+ "type": "string",
+ "enum": [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStateType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-status": {
+ "x-ms-client-name": "LeaseStatus",
+ "description": "The current lease status of the blob.",
+ "type": "string",
+ "enum": [
+ "locked",
+ "unlocked"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStatusType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-blob-public-access": {
+ "x-ms-client-name": "BlobPublicAccess",
+ "description": "Indicated whether data in the container may be accessed publicly and the level of access",
+ "type": "string",
+ "enum": [
+ "container",
+ "blob"
+ ],
+ "x-ms-enum": {
+ "name": "PublicAccessType",
+ "modelAsString": true
+ }
+ },
+ "x-ms-default-encryption-scope": {
+ "x-ms-client-name": "DefaultEncryptionScope",
+ "type": "string",
+ "description": "Default encryption scope on this container"
+ },
+ "x-ms-deny-encryption-scope-override": {
+ "x-ms-client-name": "DenyEncryptionScopeOverride",
+ "type": "boolean",
+ "description": "Whether to reject the write request with encryption scope"
+ },
+ "x-ms-has-immutability-policy": {
+ "x-ms-client-name": "HasImmutabilityPolicy",
+ "description": "Indicates whether the container has an immutability policy set on it.",
+ "type": "boolean"
+ },
+ "x-ms-has-legal-hold": {
+ "x-ms-client-name": "HasLegalHold",
+ "description": "Indicates whether the container has a legal hold.",
+ "type": "boolean"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_Delete",
+ "description": "operation marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ }
+ ]
+ },
+ "/{containerName}?restype=container&comp=metadata": {
+ "put": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_SetMetadata",
+ "description": "operation sets one or more user-defined name-value pairs for the specified container.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "metadata"
+ ]
+ }
+ ]
+ },
+ "/{containerName}?restype=container&comp=acl": {
+ "get": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_GetAccessPolicy",
+ "description": "gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "x-ms-blob-public-access": {
+ "x-ms-client-name": "BlobPublicAccess",
+ "description": "Indicated whether data in the container may be accessed publicly and the level of access",
+ "type": "string",
+ "enum": [
+ "container",
+ "blob"
+ ],
+ "x-ms-enum": {
+ "name": "PublicAccessType",
+ "modelAsString": true
+ }
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/SignedIdentifiers"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_SetAccessPolicy",
+ "description": "sets the permissions for the specified container. The permissions indicate whether blobs in a container may be accessed publicly.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ContainerAcl"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/BlobPublicAccess"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "acl"
+ ]
+ }
+ ]
+ },
+ "/{containerName}?comp=lease&restype=container&acquire": {
+ "put": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_AcquireLease",
+ "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseDuration"
+ },
+ {
+ "$ref": "#/parameters/ProposedLeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The Acquire operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-lease-id": {
+ "x-ms-client-name": "LeaseId",
+ "type": "string",
+ "description": "Uniquely identifies a container's lease"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "acquire"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}?comp=lease&restype=container&release": {
+ "put": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_ReleaseLease",
+ "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdRequired"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Release operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "release"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}?comp=lease&restype=container&renew": {
+ "put": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_RenewLease",
+ "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdRequired"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Renew operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-lease-id": {
+ "x-ms-client-name": "LeaseId",
+ "type": "string",
+ "description": "Uniquely identifies a container's lease"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "renew"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}?comp=lease&restype=container&break": {
+ "put": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_BreakLease",
+ "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseBreakPeriod"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The Break operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-lease-time": {
+ "x-ms-client-name": "LeaseTime",
+ "type": "integer",
+ "description": "Approximate time remaining in the lease period, in seconds."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "break"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}?comp=lease&restype=container&change": {
+ "put": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_ChangeLease",
+ "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdRequired"
+ },
+ {
+ "$ref": "#/parameters/ProposedLeaseIdRequired"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Change operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-lease-id": {
+ "x-ms-client-name": "LeaseId",
+ "type": "string",
+ "description": "Uniquely identifies a container's lease"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "change"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}?restype=container&comp=list&flat": {
+ "get": {
+ "tags": [
+ "containers"
+ ],
+ "operationId": "Container_ListBlobFlatSegment",
+ "description": "[Update] The List Blobs operation returns a list of the blobs under the specified container",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Prefix"
+ },
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/MaxResults"
+ },
+ {
+ "$ref": "#/parameters/ListBlobsInclude"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "Content-Type": {
+ "type": "string",
+ "description": "The media type of the body of the response. For List Blobs this is 'application/xml'"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/ListBlobsFlatSegmentResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "NextMarker"
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "list"
+ ]
+ }
+ ]
+ },
+ "/{containerName}?restype=container&comp=list&hierarchy": {
+ "get": {
+ "tags": [
+ "containers"
+ ],
+ "operationId": "Container_ListBlobHierarchySegment",
+ "description": "[Update] The List Blobs operation returns a list of the blobs under the specified container",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Prefix"
+ },
+ {
+ "$ref": "#/parameters/Delimiter"
+ },
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/MaxResults"
+ },
+ {
+ "$ref": "#/parameters/ListBlobsInclude"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "Content-Type": {
+ "type": "string",
+ "description": "The media type of the body of the response. For List Blobs this is 'application/xml'"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/ListBlobsHierarchySegmentResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "NextMarker"
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "list"
+ ]
+ }
+ ]
+ },
+ "/{containerName}?restype=container&comp=undelete": {
+ "put": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_Restore",
+ "description": "The container restore operation restores a soft deleted container to the specified container.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ },
+ {
+ "$ref": "#/parameters/DeletedContainerName"
+ },
+ {
+ "$ref": "#/parameters/DeletedContainerVersion"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The container was restored.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "container"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "undelete"
+ ]
+ }
+ ]
+ },
+ "/{containerName}?restype=account&comp=properties": {
+ "get": {
+ "tags": [
+ "container"
+ ],
+ "operationId": "Container_GetAccountInfo",
+ "description": "Returns the sku name and account kind ",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success (OK)",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-sku-name": {
+ "x-ms-client-name": "SkuName",
+ "type": "string",
+ "enum": [
+ "Standard_LRS",
+ "Standard_GRS",
+ "Standard_RAGRS",
+ "Standard_ZRS",
+ "Premium_LRS"
+ ],
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": false
+ },
+ "description": "Identifies the sku name of the account"
+ },
+ "x-ms-account-kind": {
+ "x-ms-client-name": "AccountKind",
+ "type": "string",
+ "enum": [
+ "Storage",
+ "BlobStorage",
+ "StorageV2"
+ ],
+ "x-ms-enum": {
+ "name": "AccountKind",
+ "modelAsString": false
+ },
+ "description": "Identifies the account kind"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "account"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/{filesystem}/{path}?resource=directory&Create": {
+ "put": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_Create",
+ "description": "Create a 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"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/DirectoryProperties"
+ },
+ {
+ "$ref": "#/parameters/PosixPermissions"
+ },
+ {
+ "$ref": "#/parameters/PosixUmask"
+ },
+ {
+ "$ref": "#/parameters/XMsCacheControl"
+ },
+ {
+ "$ref": "#/parameters/XMsContentType"
+ },
+ {
+ "$ref": "#/parameters/XMsContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/XMsContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/XMsContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The file or directory was created.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "An HTTP entity tag associated with the file or directory."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "The version of the REST protocol used to process the request."
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The size of the resource in bytes."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "The version of the REST protocol used to process the request."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/DataLakeStorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "resource",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "directory"
+ ]
+ }
+ ]
+ },
+ "/{filesystem}/{path}?DirectoryRename": {
+ "put": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_Rename",
+ "description": "Rename a 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"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Continuation"
+ },
+ {
+ "$ref": "#/parameters/PathRenameMode"
+ },
+ {
+ "$ref": "#/parameters/FileRenameSource"
+ },
+ {
+ "$ref": "#/parameters/DirectoryProperties"
+ },
+ {
+ "$ref": "#/parameters/PosixPermissions"
+ },
+ {
+ "$ref": "#/parameters/PosixUmask"
+ },
+ {
+ "$ref": "#/parameters/XMsCacheControl"
+ },
+ {
+ "$ref": "#/parameters/XMsContentType"
+ },
+ {
+ "$ref": "#/parameters/XMsContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/XMsContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/XMsContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/SourceLeaseId"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The directory was renamed.",
+ "headers": {
+ "x-ms-continuation": {
+ "x-ms-client-name": "marker",
+ "type": "string",
+ "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."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "An HTTP entity tag associated with the file or directory."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "The version of the REST protocol used to process the request."
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The size of the resource in bytes."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "The version of the REST protocol used to process the request."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/DataLakeStorageError"
+ }
+ }
+ }
+ }
+ },
+ "/{filesystem}/{path}?DirectoryDelete": {
+ "delete": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_Delete",
+ "description": "Deletes the directory",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/RecursiveDirectoryDelete"
+ },
+ {
+ "$ref": "#/parameters/Continuation"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The directory was deleted.",
+ "headers": {
+ "x-ms-continuation": {
+ "x-ms-client-name": "marker",
+ "type": "string",
+ "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."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "The version of the REST protocol used to process the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "The version of the REST protocol used to process the request."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/DataLakeStorageError"
+ }
+ }
+ }
+ }
+ },
+ "/{containerName}/{blob}": {
+ "get": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_Download",
+ "description": "The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot or verison.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Snapshot"
+ },
+ {
+ "$ref": "#/parameters/VersionId"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Range"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/GetRangeContentMD5"
+ },
+ {
+ "$ref": "#/parameters/GetRangeContentCRC64"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns the content of the entire blob.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-meta": {
+ "type": "string",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of bytes present in the response body."
+ },
+ "Content-Type": {
+ "type": "string",
+ "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'"
+ },
+ "Content-Range": {
+ "type": "string",
+ "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "Content-Encoding": {
+ "type": "string",
+ "description": "This header returns the value that was specified for the Content-Encoding request header"
+ },
+ "Cache-Control": {
+ "type": "string",
+ "description": "This header is returned if it was previously specified for the blob."
+ },
+ "Content-Disposition": {
+ "type": "string",
+ "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified."
+ },
+ "Content-Language": {
+ "type": "string",
+ "description": "This header returns the value that was specified for the Content-Language request header."
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "BlobSequenceNumber",
+ "type": "integer",
+ "format": "int64",
+ "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs"
+ },
+ "x-ms-blob-type": {
+ "x-ms-client-name": "BlobType",
+ "description": "The blob's type.",
+ "type": "string",
+ "enum": [
+ "BlockBlob",
+ "PageBlob",
+ "AppendBlob"
+ ],
+ "x-ms-enum": {
+ "name": "BlobType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-copy-completion-time": {
+ "x-ms-client-name": "CopyCompletionTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
+ },
+ "x-ms-copy-status-description": {
+ "x-ms-client-name": "CopyStatusDescription",
+ "type": "string",
+ "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List"
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy."
+ },
+ "x-ms-copy-progress": {
+ "x-ms-client-name": "CopyProgress",
+ "type": "string",
+ "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List"
+ },
+ "x-ms-copy-source": {
+ "x-ms-client-name": "CopySource",
+ "type": "string",
+ "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by x-ms-copy-id.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-duration": {
+ "x-ms-client-name": "LeaseDuration",
+ "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.",
+ "type": "string",
+ "enum": [
+ "infinite",
+ "fixed"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseDurationType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-state": {
+ "x-ms-client-name": "LeaseState",
+ "description": "Lease state of the blob.",
+ "type": "string",
+ "enum": [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStateType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-status": {
+ "x-ms-client-name": "LeaseStatus",
+ "description": "The current lease status of the blob.",
+ "type": "string",
+ "enum": [
+ "locked",
+ "unlocked"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStatusType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Accept-Ranges": {
+ "type": "string",
+ "description": "Indicates that the service supports requests for partial blob content."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-blob-committed-block-count": {
+ "x-ms-client-name": "BlobCommittedBlockCount",
+ "type": "integer",
+ "description": "The number of committed blocks present in the blob. This header is returned only for append blobs."
+ },
+ "x-ms-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the blob. This header is only returned when the blob was encrypted with customer specified encryption."
+ },
+ "x-ms-blob-content-md5": {
+ "x-ms-client-name": "BlobContentMD5",
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob 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 whole blob'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"
+ },
+ "x-ms-tag-count": {
+ "x-ms-client-name": "TagCount",
+ "type": "integer",
+ "description": "The number of tags corresponding to the blob."
+ }
+ },
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ },
+ "206": {
+ "description": "Returns the content of a specified range of the blob.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-meta": {
+ "type": "string",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of bytes present in the response body."
+ },
+ "Content-Type": {
+ "type": "string",
+ "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'"
+ },
+ "Content-Range": {
+ "type": "string",
+ "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "Content-Encoding": {
+ "type": "string",
+ "description": "This header returns the value that was specified for the Content-Encoding request header"
+ },
+ "Cache-Control": {
+ "type": "string",
+ "description": "This header is returned if it was previously specified for the blob."
+ },
+ "Content-Disposition": {
+ "type": "string",
+ "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified."
+ },
+ "Content-Language": {
+ "type": "string",
+ "description": "This header returns the value that was specified for the Content-Language request header."
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "BlobSequenceNumber",
+ "type": "integer",
+ "format": "int64",
+ "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs"
+ },
+ "x-ms-blob-type": {
+ "x-ms-client-name": "BlobType",
+ "description": "The blob's type.",
+ "type": "string",
+ "enum": [
+ "BlockBlob",
+ "PageBlob",
+ "AppendBlob"
+ ],
+ "x-ms-enum": {
+ "name": "BlobType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-content-crc64": {
+ "x-ms-client-name": "ContentCrc64",
+ "type": "string",
+ "format": "byte",
+ "description": "If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)"
+ },
+ "x-ms-copy-completion-time": {
+ "x-ms-client-name": "CopyCompletionTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
+ },
+ "x-ms-copy-status-description": {
+ "x-ms-client-name": "CopyStatusDescription",
+ "type": "string",
+ "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List"
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy."
+ },
+ "x-ms-copy-progress": {
+ "x-ms-client-name": "CopyProgress",
+ "type": "string",
+ "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List"
+ },
+ "x-ms-copy-source": {
+ "x-ms-client-name": "CopySource",
+ "type": "string",
+ "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by x-ms-copy-id.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-duration": {
+ "x-ms-client-name": "LeaseDuration",
+ "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.",
+ "type": "string",
+ "enum": [
+ "infinite",
+ "fixed"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseDurationType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-state": {
+ "x-ms-client-name": "LeaseState",
+ "description": "Lease state of the blob.",
+ "type": "string",
+ "enum": [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStateType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-status": {
+ "x-ms-client-name": "LeaseStatus",
+ "description": "The current lease status of the blob.",
+ "type": "string",
+ "enum": [
+ "locked",
+ "unlocked"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStatusType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Accept-Ranges": {
+ "type": "string",
+ "description": "Indicates that the service supports requests for partial blob content."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-blob-committed-block-count": {
+ "x-ms-client-name": "BlobCommittedBlockCount",
+ "type": "integer",
+ "description": "The number of committed blocks present in the blob. This header is returned only for append blobs."
+ },
+ "x-ms-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key."
+ },
+ "x-ms-blob-content-md5": {
+ "x-ms-client-name": "BlobContentMD5",
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob 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 whole blob'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"
+ },
+ "x-ms-tag-count": {
+ "x-ms-client-name": "TagCount",
+ "type": "integer",
+ "description": "The number of tags corresponding to the blob."
+ }
+ },
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "head": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_GetProperties",
+ "description": "The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Snapshot"
+ },
+ {
+ "$ref": "#/parameters/VersionId"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns the properties of the blob.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-creation-time": {
+ "x-ms-client-name": "CreationTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the blob was created."
+ },
+ "x-ms-meta": {
+ "type": "string",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "x-ms-blob-type": {
+ "x-ms-client-name": "BlobType",
+ "description": "The blob's type.",
+ "type": "string",
+ "enum": [
+ "BlockBlob",
+ "PageBlob",
+ "AppendBlob"
+ ],
+ "x-ms-enum": {
+ "name": "BlobType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-copy-completion-time": {
+ "x-ms-client-name": "CopyCompletionTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
+ },
+ "x-ms-copy-status-description": {
+ "x-ms-client-name": "CopyStatusDescription",
+ "type": "string",
+ "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List"
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy."
+ },
+ "x-ms-copy-progress": {
+ "x-ms-client-name": "CopyProgress",
+ "type": "string",
+ "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List"
+ },
+ "x-ms-copy-source": {
+ "x-ms-client-name": "CopySource",
+ "type": "string",
+ "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by x-ms-copy-id.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-incremental-copy": {
+ "x-ms-client-name": "IsIncrementalCopy",
+ "type": "boolean",
+ "description": "Included if the blob is incremental copy blob."
+ },
+ "x-ms-copy-destination-snapshot": {
+ "x-ms-client-name": "DestinationSnapshot",
+ "type": "string",
+ "description": "Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob."
+ },
+ "x-ms-lease-duration": {
+ "x-ms-client-name": "LeaseDuration",
+ "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.",
+ "type": "string",
+ "enum": [
+ "infinite",
+ "fixed"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseDurationType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-state": {
+ "x-ms-client-name": "LeaseState",
+ "description": "Lease state of the blob.",
+ "type": "string",
+ "enum": [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStateType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-lease-status": {
+ "x-ms-client-name": "LeaseStatus",
+ "description": "The current lease status of the blob.",
+ "type": "string",
+ "enum": [
+ "locked",
+ "unlocked"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStatusType",
+ "modelAsString": false
+ }
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of bytes present in the response body."
+ },
+ "Content-Type": {
+ "type": "string",
+ "description": "The content type specified for the blob. The default content type is 'application/octet-stream'"
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "Content-Encoding": {
+ "type": "string",
+ "description": "This header returns the value that was specified for the Content-Encoding request header"
+ },
+ "Content-Disposition": {
+ "type": "string",
+ "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified."
+ },
+ "Content-Language": {
+ "type": "string",
+ "description": "This header returns the value that was specified for the Content-Language request header."
+ },
+ "Cache-Control": {
+ "type": "string",
+ "description": "This header is returned if it was previously specified for the blob."
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "BlobSequenceNumber",
+ "type": "integer",
+ "format": "int64",
+ "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "Accept-Ranges": {
+ "type": "string",
+ "description": "Indicates that the service supports requests for partial blob content."
+ },
+ "x-ms-blob-committed-block-count": {
+ "x-ms-client-name": "BlobCommittedBlockCount",
+ "type": "integer",
+ "description": "The number of committed blocks present in the blob. This header is returned only for append blobs."
+ },
+ "x-ms-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the metadata. This header is only returned when the metadata was encrypted with customer specified encryption."
+ },
+ "x-ms-access-tier": {
+ "x-ms-client-name": "AccessTier",
+ "type": "string",
+ "description": "The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob storage LRS accounts, valid values are Hot/Cool/Archive."
+ },
+ "x-ms-access-tier-inferred": {
+ "x-ms-client-name": "AccessTierInferred",
+ "type": "boolean",
+ "description": "For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value."
+ },
+ "x-ms-archive-status": {
+ "x-ms-client-name": "ArchiveStatus",
+ "type": "string",
+ "description": "For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier."
+ },
+ "x-ms-access-tier-change-time": {
+ "x-ms-client-name": "AccessTierChangeTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set."
+ },
+ "x-ms-tag-count": {
+ "x-ms-client-name": "TagCount",
+ "type": "integer",
+ "description": "The number of tags corresponding to the blob."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_Delete",
+ "description": "If the storage account's soft delete feature is disabled then, when a blob is deleted, it is permanently removed from the storage account. If the storage account's soft delete feature is enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible immediately. However, the blob service retains the blob or snapshot for the number of days specified by the DeleteRetentionPolicy section of [Storage service properties] (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is permanently removed from the storage account. Note that you continue to be charged for the soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the \"include=deleted\" query parameter to discover which blobs and snapshots have been soft deleted. You can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a soft-deleted blob or snapshot causes the service to return an HTTP status code of 404 (ResourceNotFound). If the storage account's automatic snapshot feature is enabled, then, when a blob is deleted, an automatic snapshot is created. The blob becomes inaccessible immediately. All other operations on the blob causes the service to return an HTTP status code of 404 (ResourceNotFound). You can access automatic snapshot using snapshot timestamp or version id. You can restore the blob by calling Put or Copy Blob API with automatic snapshot as source. Deleting automatic snapshot requires shared key or special SAS/RBAC permissions.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Snapshot"
+ },
+ {
+ "$ref": "#/parameters/VersionId"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/DeleteSnapshots"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The delete request was accepted and the blob will be deleted.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ }
+ },
+ "/{filesystem}/{path}?FileRename": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_Rename",
+ "description": "Rename a blob/file. 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"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/PathRenameMode"
+ },
+ {
+ "$ref": "#/parameters/FileRenameSource"
+ },
+ {
+ "$ref": "#/parameters/DirectoryProperties"
+ },
+ {
+ "$ref": "#/parameters/PosixPermissions"
+ },
+ {
+ "$ref": "#/parameters/PosixUmask"
+ },
+ {
+ "$ref": "#/parameters/XMsCacheControl"
+ },
+ {
+ "$ref": "#/parameters/XMsContentType"
+ },
+ {
+ "$ref": "#/parameters/XMsContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/XMsContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/XMsContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/SourceLeaseId"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The file was renamed.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "An HTTP entity tag associated with the file or directory."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "The version of the REST protocol used to process the request."
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The size of the resource in bytes."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "The version of the REST protocol used to process the request."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/DataLakeStorageError"
+ }
+ }
+ }
+ }
+ },
+ "/{containerName}/{blob}?PageBlob": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "PageBlob_Create",
+ "description": "The Create operation creates a new page blob.",
+ "consumes": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/BlobContentType"
+ },
+ {
+ "$ref": "#/parameters/BlobContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/BlobContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/BlobContentMD5"
+ },
+ {
+ "$ref": "#/parameters/BlobCacheControl"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/BlobContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/BlobTagsHeader"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/BlobContentLengthRequired"
+ },
+ {
+ "$ref": "#/parameters/BlobSequenceNumber"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The blob was created.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "x-ms-version-id": {
+ "x-ms-client-name": "VersionId",
+ "type": "string",
+ "description": "UTC date/time value generated by the service that identifies a version of the blob. This header is returned for requests made against version 2018-11-09 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the blob. This header is only returned when the blob was encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "x-ms-blob-type",
+ "x-ms-client-name": "blobType",
+ "in": "header",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Specifies the type of blob to create: block blob, page blob, or append blob.",
+ "type": "string",
+ "enum": [
+ "PageBlob"
+ ],
+ "x-ms-enum": {
+ "name": "BlobType",
+ "modelAsString": false
+ }
+ }
+ ]
+ },
+ "/{containerName}/{blob}?AppendBlob": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "AppendBlob_Create",
+ "description": "The Create Append Blob operation creates a new append blob.",
+ "consumes": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/BlobContentType"
+ },
+ {
+ "$ref": "#/parameters/BlobContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/BlobContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/BlobContentMD5"
+ },
+ {
+ "$ref": "#/parameters/BlobCacheControl"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/BlobContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/BlobTagsHeader"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The blob was created.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "x-ms-version-id": {
+ "x-ms-client-name": "VersionId",
+ "type": "string",
+ "description": "UTC date/time value generated by the service that identifies a version of the blob. This header is returned for requests made against version 2018-11-09 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the blob. This header is only returned when the blob was encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "x-ms-blob-type",
+ "x-ms-client-name": "blobType",
+ "in": "header",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Specifies the type of blob to create: block blob, page blob, or append blob.",
+ "type": "string",
+ "enum": [
+ "AppendBlob"
+ ],
+ "x-ms-enum": {
+ "name": "BlobType",
+ "modelAsString": false
+ }
+ }
+ ]
+ },
+ "/{containerName}/{blob}?BlockBlob": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "BlockBlob_Upload",
+ "description": "The Upload Block Blob operation updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a partial update of the content of a block blob, use the Put Block List operation.",
+ "consumes": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/Body"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/BlobContentType"
+ },
+ {
+ "$ref": "#/parameters/BlobContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/BlobContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/BlobContentMD5"
+ },
+ {
+ "$ref": "#/parameters/BlobCacheControl"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/BlobContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/BlobTagsHeader"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/AccessTierOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The blob was updated.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "x-ms-version-id": {
+ "x-ms-client-name": "VersionId",
+ "type": "string",
+ "description": "UTC date/time value generated by the service that identifies a version of the blob. This header is returned for requests made against version 2018-11-09 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the blob. This header is only returned when the blob was encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "x-ms-blob-type",
+ "x-ms-client-name": "blobType",
+ "in": "header",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Specifies the type of blob to create: block blob, page blob, or append blob.",
+ "type": "string",
+ "enum": [
+ "BlockBlob"
+ ],
+ "x-ms-enum": {
+ "name": "BlobType",
+ "modelAsString": false
+ }
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=undelete": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_Undelete",
+ "description": "Undelete a blob that was previously soft deleted",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The blob was undeleted successfully.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "undelete"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=properties&SetHTTPHeaders": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_SetHTTPHeaders",
+ "description": "The Set HTTP Headers operation sets system properties on the blob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/BlobCacheControl"
+ },
+ {
+ "$ref": "#/parameters/BlobContentType"
+ },
+ {
+ "$ref": "#/parameters/BlobContentMD5"
+ },
+ {
+ "$ref": "#/parameters/BlobContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/BlobContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/BlobContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The properties were set successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "BlobSequenceNumber",
+ "type": "integer",
+ "format": "int64",
+ "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=metadata": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_SetMetadata",
+ "description": "The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more name-value pairs",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The metadata was set successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the pages. This header is only returned when the pages were encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "metadata"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=lease&acquire": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_AcquireLease",
+ "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseDuration"
+ },
+ {
+ "$ref": "#/parameters/ProposedLeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The Acquire operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-lease-id": {
+ "x-ms-client-name": "LeaseId",
+ "type": "string",
+ "description": "Uniquely identifies a blobs's lease"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "acquire"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=lease&release": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_ReleaseLease",
+ "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdRequired"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Release operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "release"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=lease&renew": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_RenewLease",
+ "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdRequired"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Renew operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-lease-id": {
+ "x-ms-client-name": "LeaseId",
+ "type": "string",
+ "description": "Uniquely identifies a blobs's lease"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "renew"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=lease&change": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_ChangeLease",
+ "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdRequired"
+ },
+ {
+ "$ref": "#/parameters/ProposedLeaseIdRequired"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Change operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-lease-id": {
+ "x-ms-client-name": "LeaseId",
+ "type": "string",
+ "description": "Uniquely identifies a blobs's lease"
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "change"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=lease&break": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_BreakLease",
+ "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseBreakPeriod"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The Break operation completed successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-lease-time": {
+ "x-ms-client-name": "LeaseTime",
+ "type": "integer",
+ "description": "Approximate time remaining in the lease period, in seconds."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "lease"
+ ]
+ },
+ {
+ "name": "x-ms-lease-action",
+ "x-ms-client-name": "action",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "break"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseAction",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Describes what lease action to take."
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=snapshot": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_CreateSnapshot",
+ "description": "The Create Snapshot operation creates a read-only snapshot of a blob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The snaptshot was taken successfully.",
+ "headers": {
+ "x-ms-snapshot": {
+ "x-ms-client-name": "Snapshot",
+ "type": "string",
+ "description": "Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot"
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "x-ms-version-id": {
+ "x-ms-client-name": "VersionId",
+ "type": "string",
+ "description": "UTC date/time value generated by the service that identifies the version of the blob. This header is returned for requests made against version 2018-11-09 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the source blob. This header is only returned when the blob was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the source blob. This header is only returned when the blob was encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "snapshot"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=copy": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_StartCopyFromURL",
+ "description": "The Start Copy From URL operation copies a blob or an internet resource to a new blob.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/BlobTagsHeader"
+ },
+ {
+ "$ref": "#/parameters/AccessTierOptional"
+ },
+ {
+ "$ref": "#/parameters/RehydratePriority"
+ },
+ {
+ "$ref": "#/parameters/SourceIfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/CopySource"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The copy blob has been accepted with the specified copy status.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "x-ms-version-id": {
+ "x-ms-client-name": "VersionId",
+ "type": "string",
+ "description": "UTC date/time value generated by the service that identifies the version of the blob. This header is returned for requests made against version 2018-11-09 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by x-ms-copy-id.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": []
+ },
+ "/{containerName}/{blob}?comp=copy&sync": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_CopyFromURL",
+ "description": "The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return a response until the copy is complete.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/BlobTagsHeader"
+ },
+ {
+ "$ref": "#/parameters/AccessTierOptional"
+ },
+ {
+ "$ref": "#/parameters/SourceIfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/CopySource"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The copy has completed.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "x-ms-version-id": {
+ "x-ms-client-name": "VersionId",
+ "type": "string",
+ "description": "UTC date/time value generated by the service that identifies the version of the blob. This header is returned for requests made against version 2018-11-09 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for this copy operation."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by x-ms-copy-id.",
+ "type": "string",
+ "enum": [
+ "success"
+ ],
+ "x-ms-enum": {
+ "name": "SyncCopyStatusType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "x-ms-requires-sync",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "true"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=copy©id={CopyId}": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_AbortCopyFromURL",
+ "description": "The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination blob with zero length and full metadata.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/CopyId"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "The delete request was accepted and the blob will be deleted.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "copy"
+ ]
+ },
+ {
+ "name": "x-ms-copy-action",
+ "x-ms-client-name": "copyActionAbortConstant",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "abort"
+ ],
+ "x-ms-parameter-location": "method"
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=tier": {
+ "put": {
+ "tags": [
+ "blobs"
+ ],
+ "operationId": "Blob_SetTier",
+ "description": "The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/AccessTierRequired"
+ },
+ {
+ "$ref": "#/parameters/RehydratePriority"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The new tier will take effect immediately.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and newer."
+ }
+ }
+ },
+ "202": {
+ "description": "The transition to the new tier is pending.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and newer."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "tier"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?restype=account&comp=properties": {
+ "get": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_GetAccountInfo",
+ "description": "Returns the sku name and account kind ",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success (OK)",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-sku-name": {
+ "x-ms-client-name": "SkuName",
+ "type": "string",
+ "enum": [
+ "Standard_LRS",
+ "Standard_GRS",
+ "Standard_RAGRS",
+ "Standard_ZRS",
+ "Premium_LRS"
+ ],
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": false
+ },
+ "description": "Identifies the sku name of the account"
+ },
+ "x-ms-account-kind": {
+ "x-ms-client-name": "AccountKind",
+ "type": "string",
+ "enum": [
+ "Storage",
+ "BlobStorage",
+ "StorageV2"
+ ],
+ "x-ms-enum": {
+ "name": "AccountKind",
+ "modelAsString": false
+ },
+ "description": "Identifies the account kind"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "account"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=tags": {
+ "put": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_SetTags",
+ "description": "The Set Blob Tags operation sets tags for the specified blob. This API is only supported in version 2018-11-09 and later.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/BlobTagsBody"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/ContentMD5"
+ },
+ {
+ "$ref": "#/parameters/ContentCrc64"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "The tags were set.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "blob"
+ ],
+ "operationId": "Blob_GetTags",
+ "description": "The Get Blob Tags operation returns all tags for the specified blob, snapshot, or version. This API is only supported in version 2018-11-09 and later.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/Snapshot"
+ },
+ {
+ "$ref": "#/parameters/VersionId"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns the tags.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/BlobTags"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "tags"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=block": {
+ "put": {
+ "tags": [
+ "blockblob"
+ ],
+ "operationId": "BlockBlob_StageBlock",
+ "description": "The Stage Block operation creates a new block to be committed as part of a blob",
+ "consumes": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/BlockId"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/ContentMD5"
+ },
+ {
+ "$ref": "#/parameters/ContentCrc64"
+ },
+ {
+ "$ref": "#/parameters/Body"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The block was created.",
+ "headers": {
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-content-crc64": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the block. This header is only returned when the block was encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "block"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=block&fromURL": {
+ "put": {
+ "tags": [
+ "blockblob"
+ ],
+ "operationId": "BlockBlob_StageBlockFromURL",
+ "description": "The Stage Block operation creates a new block to be committed as part of a blob where the contents are read from a URL.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/BlockId"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/SourceUrl"
+ },
+ {
+ "$ref": "#/parameters/SourceRange"
+ },
+ {
+ "$ref": "#/parameters/SourceContentMD5"
+ },
+ {
+ "$ref": "#/parameters/SourceContentCRC64"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ },
+ {
+ "$ref": "#/parameters/SourceIfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfNoneMatch"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The block was created.",
+ "headers": {
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers."
+ },
+ "x-ms-content-crc64": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the block. This header is only returned when the block was encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "block"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=blocklist": {
+ "put": {
+ "tags": [
+ "blockblob"
+ ],
+ "operationId": "BlockBlob_CommitBlockList",
+ "description": "The Commit Block List operation writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior Put Block operation. You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/BlobCacheControl"
+ },
+ {
+ "$ref": "#/parameters/BlobContentType"
+ },
+ {
+ "$ref": "#/parameters/BlobContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/BlobContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/BlobContentMD5"
+ },
+ {
+ "$ref": "#/parameters/ContentMD5"
+ },
+ {
+ "$ref": "#/parameters/ContentCrc64"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/BlobContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/BlobTagsHeader"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/AccessTierOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "name": "blocks",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BlockLookupList"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The block list was recorded.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself."
+ },
+ "x-ms-content-crc64": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "x-ms-version-id": {
+ "x-ms-client-name": "VersionId",
+ "type": "string",
+ "description": "UTC date/time value generated by the service that identifies a version of the blob. This header is returned for requests made against version 2018-11-09 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the blob. This header is only returned when the blob was encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "blockblob"
+ ],
+ "operationId": "BlockBlob_GetBlockList",
+ "description": "The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block blob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Snapshot"
+ },
+ {
+ "$ref": "#/parameters/VersionId"
+ },
+ {
+ "$ref": "#/parameters/BlockListType"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The page range was written.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Content-Type": {
+ "type": "string",
+ "description": "The media type of the body of the response. For Get Block List this is 'application/xml'"
+ },
+ "x-ms-blob-content-length": {
+ "x-ms-client-name": "BlobContentLength",
+ "type": "integer",
+ "format": "int64",
+ "description": "The size of the blob in bytes."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/BlockList"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "blocklist"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=page&update": {
+ "put": {
+ "tags": [
+ "pageblob"
+ ],
+ "operationId": "PageBlob_UploadPages",
+ "description": "The Upload Pages operation writes a range of pages to a page blob",
+ "consumes": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/Body"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/ContentMD5"
+ },
+ {
+ "$ref": "#/parameters/ContentCrc64"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Range"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/IfSequenceNumberLessThanOrEqualTo"
+ },
+ {
+ "$ref": "#/parameters/IfSequenceNumberLessThan"
+ },
+ {
+ "$ref": "#/parameters/IfSequenceNumberEqualTo"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The page range was written.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "x-ms-content-crc64": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers."
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "BlobSequenceNumber",
+ "type": "integer",
+ "format": "int64",
+ "description": "The current sequence number for the page blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the pages. This header is only returned when the pages were encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the pages. This header is only returned when the pages were encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "page"
+ ]
+ },
+ {
+ "name": "x-ms-page-write",
+ "x-ms-client-name": "pageWrite",
+ "in": "header",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Required. You may specify one of the following options:\n - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update.\n - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size.",
+ "type": "string",
+ "enum": [
+ "update"
+ ],
+ "x-ms-enum": {
+ "name": "PageWriteType",
+ "modelAsString": false
+ }
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=page&clear": {
+ "put": {
+ "tags": [
+ "pageblob"
+ ],
+ "operationId": "PageBlob_ClearPages",
+ "description": "The Clear Pages operation clears a set of pages from a page blob",
+ "consumes": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Range"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/IfSequenceNumberLessThanOrEqualTo"
+ },
+ {
+ "$ref": "#/parameters/IfSequenceNumberLessThan"
+ },
+ {
+ "$ref": "#/parameters/IfSequenceNumberEqualTo"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The page range was cleared.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "x-ms-content-crc64": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers."
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "BlobSequenceNumber",
+ "type": "integer",
+ "format": "int64",
+ "description": "The current sequence number for the page blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "page"
+ ]
+ },
+ {
+ "name": "x-ms-page-write",
+ "x-ms-client-name": "pageWrite",
+ "in": "header",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Required. You may specify one of the following options:\n - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update.\n - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size.",
+ "type": "string",
+ "enum": [
+ "clear"
+ ],
+ "x-ms-enum": {
+ "name": "PageWriteType",
+ "modelAsString": false
+ }
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=page&update&fromUrl": {
+ "put": {
+ "tags": [
+ "pageblob"
+ ],
+ "operationId": "PageBlob_UploadPagesFromURL",
+ "description": "The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL",
+ "consumes": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SourceUrl"
+ },
+ {
+ "$ref": "#/parameters/SourceRangeRequiredPutPageFromUrl"
+ },
+ {
+ "$ref": "#/parameters/SourceContentMD5"
+ },
+ {
+ "$ref": "#/parameters/SourceContentCRC64"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/RangeRequiredPutPageFromUrl"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfSequenceNumberLessThanOrEqualTo"
+ },
+ {
+ "$ref": "#/parameters/IfSequenceNumberLessThan"
+ },
+ {
+ "$ref": "#/parameters/IfSequenceNumberEqualTo"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The page range was written.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "x-ms-content-crc64": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers."
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "BlobSequenceNumber",
+ "type": "integer",
+ "format": "int64",
+ "description": "The current sequence number for the page blob."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "page"
+ ]
+ },
+ {
+ "name": "x-ms-page-write",
+ "x-ms-client-name": "pageWrite",
+ "in": "header",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Required. You may specify one of the following options:\n - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update.\n - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size.",
+ "type": "string",
+ "enum": [
+ "update"
+ ],
+ "x-ms-enum": {
+ "name": "PageWriteType",
+ "modelAsString": false
+ }
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=pagelist": {
+ "get": {
+ "tags": [
+ "pageblob"
+ ],
+ "operationId": "PageBlob_GetPageRanges",
+ "description": "The Get Page Ranges operation returns the list of valid page ranges for a page blob, version or snapshot of a page blob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Snapshot"
+ },
+ {
+ "$ref": "#/parameters/VersionId"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Range"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Information on the page blob was found.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "x-ms-blob-content-length": {
+ "x-ms-client-name": "BlobContentLength",
+ "type": "integer",
+ "format": "int64",
+ "description": "The size of the blob in bytes."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/PageList"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "pagelist"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=pagelist&diff": {
+ "get": {
+ "tags": [
+ "pageblob"
+ ],
+ "operationId": "PageBlob_GetPageRangesDiff",
+ "description": "[Update] The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were changed between target blob/snapshot/version and previous snapshot.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Snapshot"
+ },
+ {
+ "$ref": "#/parameters/VersionId"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/PrevSnapshot"
+ },
+ {
+ "$ref": "#/parameters/PrevSnapshotUrl"
+ },
+ {
+ "$ref": "#/parameters/Range"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Information on the page blob was found.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "x-ms-blob-content-length": {
+ "x-ms-client-name": "BlobContentLength",
+ "type": "integer",
+ "format": "int64",
+ "description": "The size of the blob in bytes."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/PageList"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "pagelist"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=properties&Resize": {
+ "put": {
+ "tags": [
+ "pageblob"
+ ],
+ "operationId": "PageBlob_Resize",
+ "description": "Resize the Blob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/BlobContentLengthRequired"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Blob was resized successfully",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "BlobSequenceNumber",
+ "type": "integer",
+ "format": "int64",
+ "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=properties&UpdateSequenceNumber": {
+ "put": {
+ "tags": [
+ "pageblob"
+ ],
+ "operationId": "PageBlob_UpdateSequenceNumber",
+ "description": "Update the sequence number of the blob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/SequenceNumberAction"
+ },
+ {
+ "$ref": "#/parameters/BlobSequenceNumber"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The sequence numbers were updated successfully.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "BlobSequenceNumber",
+ "type": "integer",
+ "format": "int64",
+ "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs"
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=incrementalcopy": {
+ "put": {
+ "tags": [
+ "pageblob"
+ ],
+ "operationId": "PageBlob_CopyIncremental",
+ "description": "The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. This API is supported since REST version 2016-05-31.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/CopySource"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The blob was copied.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by x-ms-copy-id.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "incrementalcopy"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=appendblock": {
+ "put": {
+ "tags": [
+ "appendblob"
+ ],
+ "operationId": "AppendBlob_AppendBlock",
+ "description": "The Append Block operation commits a new block of data to the end of an existing append blob. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Body"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/ContentMD5"
+ },
+ {
+ "$ref": "#/parameters/ContentCrc64"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/BlobConditionMaxSize"
+ },
+ {
+ "$ref": "#/parameters/BlobConditionAppendPos"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/EncryptionScope"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The block was created.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "x-ms-content-crc64": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers."
+ },
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-blob-append-offset": {
+ "x-ms-client-name": "BlobAppendOffset",
+ "type": "string",
+ "description": "This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes."
+ },
+ "x-ms-blob-committed-block-count": {
+ "x-ms-client-name": "BlobCommittedBlockCount",
+ "type": "integer",
+ "description": "The number of committed blocks present in the blob. This header is returned only for append blobs."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key."
+ },
+ "x-ms-encryption-scope": {
+ "x-ms-client-name": "EncryptionScope",
+ "type": "string",
+ "description": "The encryption scope used to encrypt the block. This header is only returned when the block was encrypted with customer specified encryption."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "appendblock"
+ ]
+ }
+ ]
+ },
+ "/{containerName}/{blob}?comp=appendblock&fromUrl": {
+ "put": {
+ "tags": [
+ "appendblob"
+ ],
+ "operationId": "AppendBlob_AppendBlockFromUrl",
+ "description": "The Append Block operation commits a new block of data to the end of an existing append blob where the contents are read from a source url. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SourceUrl"
+ },
+ {
+ "$ref": "#/parameters/SourceRange"
+ },
+ {
+ "$ref": "#/parameters/SourceContentMD5"
+ },
+ {
+ "$ref": "#/parameters/SourceContentCRC64"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/ContentMD5"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKey"
+ },
+ {
+ "$ref": "#/parameters/EncryptionKeySha256"
+ },
+ {
+ "$ref": "#/parameters/EncryptionAlgorithm"
+ },
+ {
+ "$ref": "#/parameters/LeaseIdOptional"
+ },
+ {
+ "$ref": "#/parameters/BlobConditionMaxSize"
+ },
+ {
+ "$ref": "#/parameters/BlobConditionAppendPos"
+ },
+ {
+ "$ref": "#/parameters/IfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/IfMatch"
+ },
+ {
+ "$ref": "#/parameters/IfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfModifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfUnmodifiedSince"
+ },
+ {
+ "$ref": "#/parameters/SourceIfMatch"
+ },
+ {
+ "$ref": "#/parameters/SourceIfNoneMatch"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The block was created.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
+ },
+ "x-ms-content-crc64": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-blob-append-offset": {
+ "x-ms-client-name": "BlobAppendOffset",
+ "type": "string",
+ "description": "This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes."
+ },
+ "x-ms-blob-committed-block-count": {
+ "x-ms-client-name": "BlobCommittedBlockCount",
+ "type": "integer",
+ "description": "The number of committed blocks present in the blob. This header is returned only for append blobs."
+ },
+ "x-ms-encryption-key-sha256": {
+ "x-ms-client-name": "EncryptionKeySha256",
+ "type": "string",
+ "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "appendblock"
+ ]
+ }
+ ]
+ }
+ },
+ "definitions": {
+ "KeyInfo": {
+ "type": "object",
+ "required": [
+ "Start",
+ "Expiry"
+ ],
+ "description": "Key information",
+ "properties": {
+ "Start": {
+ "description": "The date-time the key is active in ISO 8601 UTC time",
+ "type": "string"
+ },
+ "Expiry": {
+ "description": "The date-time the key expires in ISO 8601 UTC time",
+ "type": "string"
+ }
+ }
+ },
+ "UserDelegationKey": {
+ "type": "object",
+ "required": [
+ "SignedOid",
+ "SignedTid",
+ "SignedStart",
+ "SignedExpiry",
+ "SignedService",
+ "SignedVersion",
+ "Value"
+ ],
+ "description": "A user delegation key",
+ "properties": {
+ "SignedOid": {
+ "description": "The Azure Active Directory object ID in GUID format.",
+ "type": "string"
+ },
+ "SignedTid": {
+ "description": "The Azure Active Directory tenant ID in GUID format",
+ "type": "string"
+ },
+ "SignedStart": {
+ "description": "The date-time the key is active",
+ "type": "string",
+ "format": "date-time"
+ },
+ "SignedExpiry": {
+ "description": "The date-time the key expires",
+ "type": "string",
+ "format": "date-time"
+ },
+ "SignedService": {
+ "description": "Abbreviation of the Azure Storage service that accepts the key",
+ "type": "string"
+ },
+ "SignedVersion": {
+ "description": "The service version that created the key",
+ "type": "string"
+ },
+ "Value": {
+ "description": "The key as a base64 string",
+ "type": "string"
+ }
+ }
+ },
+ "PublicAccessType": {
+ "type": "string",
+ "enum": [
+ "container",
+ "blob"
+ ],
+ "x-ms-enum": {
+ "name": "PublicAccessType",
+ "modelAsString": true
+ }
+ },
+ "CopyStatus": {
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ },
+ "LeaseDuration": {
+ "type": "string",
+ "enum": [
+ "infinite",
+ "fixed"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseDurationType",
+ "modelAsString": false
+ }
+ },
+ "LeaseState": {
+ "type": "string",
+ "enum": [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStateType",
+ "modelAsString": false
+ }
+ },
+ "LeaseStatus": {
+ "type": "string",
+ "enum": [
+ "locked",
+ "unlocked"
+ ],
+ "x-ms-enum": {
+ "name": "LeaseStatusType",
+ "modelAsString": false
+ }
+ },
+ "StorageError": {
+ "type": "object",
+ "properties": {
+ "Message": {
+ "type": "string"
+ }
+ }
+ },
+ "DataLakeStorageError": {
+ "type": "object",
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "AccessPolicy": {
+ "type": "object",
+ "required": [
+ "Start",
+ "Expiry",
+ "Permission"
+ ],
+ "description": "An Access policy",
+ "properties": {
+ "Start": {
+ "description": "the date-time the policy is active",
+ "type": "string",
+ "format": "date-time"
+ },
+ "Expiry": {
+ "description": "the date-time the policy expires",
+ "type": "string",
+ "format": "date-time"
+ },
+ "Permission": {
+ "description": "the permissions for the acl policy",
+ "type": "string"
+ }
+ }
+ },
+ "AccessTier": {
+ "type": "string",
+ "enum": [
+ "P4",
+ "P6",
+ "P10",
+ "P20",
+ "P30",
+ "P40",
+ "P50",
+ "Hot",
+ "Cool",
+ "Archive"
+ ],
+ "x-ms-enum": {
+ "name": "AccessTier",
+ "modelAsString": true
+ }
+ },
+ "ArchiveStatus": {
+ "type": "string",
+ "enum": [
+ "rehydrate-pending-to-hot",
+ "rehydrate-pending-to-cool"
+ ],
+ "x-ms-enum": {
+ "name": "ArchiveStatus",
+ "modelAsString": true
+ }
+ },
+ "BlobItem": {
+ "xml": {
+ "name": "Blob"
+ },
+ "description": "An Azure Storage blob",
+ "type": "object",
+ "required": [
+ "Name",
+ "Deleted",
+ "Snapshot",
+ "VersionId",
+ "Properties"
+ ],
+ "properties": {
+ "Name": {
+ "type": "string"
+ },
+ "Deleted": {
+ "type": "boolean"
+ },
+ "Snapshot": {
+ "type": "string"
+ },
+ "VersionId": {
+ "type": "string"
+ },
+ "Properties": {
+ "$ref": "#/definitions/BlobProperties"
+ },
+ "Metadata": {
+ "$ref": "#/definitions/BlobMetadata"
+ },
+ "Tags": {
+ "$ref": "#/definitions/BlobTags"
+ }
+ }
+ },
+ "BlobProperties": {
+ "xml": {
+ "name": "Properties"
+ },
+ "description": "Properties of a blob",
+ "type": "object",
+ "required": [
+ "Etag",
+ "Last-Modified",
+ "TagCount"
+ ],
+ "properties": {
+ "Creation-Time": {
+ "type": "string",
+ "format": "date-time-rfc1123"
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123"
+ },
+ "Etag": {
+ "type": "string",
+ "format": "etag"
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Size in bytes"
+ },
+ "Content-Type": {
+ "type": "string"
+ },
+ "Content-Encoding": {
+ "type": "string"
+ },
+ "Content-Language": {
+ "type": "string"
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte"
+ },
+ "Content-Disposition": {
+ "type": "string"
+ },
+ "Cache-Control": {
+ "type": "string"
+ },
+ "x-ms-blob-sequence-number": {
+ "x-ms-client-name": "blobSequenceNumber",
+ "type": "integer",
+ "format": "int64"
+ },
+ "BlobType": {
+ "type": "string",
+ "enum": [
+ "BlockBlob",
+ "PageBlob",
+ "AppendBlob"
+ ],
+ "x-ms-enum": {
+ "name": "BlobType",
+ "modelAsString": false
+ }
+ },
+ "LeaseStatus": {
+ "$ref": "#/definitions/LeaseStatus"
+ },
+ "LeaseState": {
+ "$ref": "#/definitions/LeaseState"
+ },
+ "LeaseDuration": {
+ "$ref": "#/definitions/LeaseDuration"
+ },
+ "CopyId": {
+ "type": "string"
+ },
+ "CopyStatus": {
+ "$ref": "#/definitions/CopyStatus"
+ },
+ "CopySource": {
+ "type": "string"
+ },
+ "CopyProgress": {
+ "type": "string"
+ },
+ "CopyCompletionTime": {
+ "type": "string",
+ "format": "date-time-rfc1123"
+ },
+ "CopyStatusDescription": {
+ "type": "string"
+ },
+ "ServerEncrypted": {
+ "type": "boolean"
+ },
+ "IncrementalCopy": {
+ "type": "boolean"
+ },
+ "DestinationSnapshot": {
+ "type": "string"
+ },
+ "DeletedTime": {
+ "type": "string",
+ "format": "date-time-rfc1123"
+ },
+ "RemainingRetentionDays": {
+ "type": "integer"
+ },
+ "AccessTier": {
+ "$ref": "#/definitions/AccessTier"
+ },
+ "AccessTierInferred": {
+ "type": "boolean"
+ },
+ "ArchiveStatus": {
+ "$ref": "#/definitions/ArchiveStatus"
+ },
+ "CustomerProvidedKeySha256": {
+ "type": "string"
+ },
+ "EncryptionScope": {
+ "type": "string"
+ },
+ "AccessTierChangeTime": {
+ "type": "string",
+ "format": "date-time-rfc1123"
+ },
+ "TagCount": {
+ "type": "integer",
+ "description": "The number of tags corresponding to the blob."
+ }
+ }
+ },
+ "ListBlobsFlatSegmentResponse": {
+ "xml": {
+ "name": "EnumerationResults"
+ },
+ "description": "An enumeration of blobs",
+ "type": "object",
+ "required": [
+ "ServiceEndpoint",
+ "ContainerName",
+ "Segment"
+ ],
+ "properties": {
+ "ServiceEndpoint": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "ContainerName": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "Prefix": {
+ "type": "string"
+ },
+ "Marker": {
+ "type": "string"
+ },
+ "MaxResults": {
+ "type": "integer"
+ },
+ "Delimiter": {
+ "type": "string"
+ },
+ "Segment": {
+ "$ref": "#/definitions/BlobFlatListSegment"
+ },
+ "NextMarker": {
+ "type": "string"
+ }
+ }
+ },
+ "ListBlobsHierarchySegmentResponse": {
+ "xml": {
+ "name": "EnumerationResults"
+ },
+ "description": "An enumeration of blobs",
+ "type": "object",
+ "required": [
+ "ServiceEndpoint",
+ "ContainerName",
+ "Prefix",
+ "Marker",
+ "MaxResults",
+ "Delimiter",
+ "Segment",
+ "NextMarker"
+ ],
+ "properties": {
+ "ServiceEndpoint": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "ContainerName": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "Prefix": {
+ "type": "string"
+ },
+ "Marker": {
+ "type": "string"
+ },
+ "MaxResults": {
+ "type": "integer"
+ },
+ "Delimiter": {
+ "type": "string"
+ },
+ "Segment": {
+ "$ref": "#/definitions/BlobHierarchyListSegment"
+ },
+ "NextMarker": {
+ "type": "string"
+ }
+ }
+ },
+ "BlobFlatListSegment": {
+ "xml": {
+ "name": "Blobs"
+ },
+ "required": [
+ "BlobItems"
+ ],
+ "type": "object",
+ "properties": {
+ "BlobItems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BlobItem"
+ }
+ }
+ }
+ },
+ "BlobHierarchyListSegment": {
+ "xml": {
+ "name": "Blobs"
+ },
+ "type": "object",
+ "required": [
+ "BlobItems"
+ ],
+ "properties": {
+ "BlobPrefixes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BlobPrefix"
+ }
+ },
+ "BlobItems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BlobItem"
+ }
+ }
+ }
+ },
+ "BlobPrefix": {
+ "type": "object",
+ "required": [
+ "Name"
+ ],
+ "properties": {
+ "Name": {
+ "type": "string"
+ }
+ }
+ },
+ "Tag": {
+ "type": "object",
+ "required": [
+ "Key",
+ "Value"
+ ],
+ "description": "Represents a single user-provided tag.",
+ "properties": {
+ "Key": {
+ "description": "The tag name.",
+ "type": "string"
+ },
+ "Value": {
+ "description": "The tag value.",
+ "type": "string"
+ }
+ }
+ },
+ "BlobTags": {
+ "xml": {
+ "name": "Tags"
+ },
+ "description": "XML containing key/value pairs representing the tags for the blob.",
+ "properties": {
+ "TagSet": {
+ "xml": {
+ "wrapped": true
+ },
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Tag"
+ }
+ }
+ }
+ },
+ "Block": {
+ "type": "object",
+ "required": [
+ "Name",
+ "Size"
+ ],
+ "description": "Represents a single block in a block blob. It describes the block's ID and size.",
+ "properties": {
+ "Name": {
+ "description": "The base64 encoded block ID.",
+ "type": "string"
+ },
+ "Size": {
+ "description": "The block size in bytes.",
+ "type": "integer"
+ }
+ }
+ },
+ "BlockList": {
+ "type": "object",
+ "properties": {
+ "CommittedBlocks": {
+ "xml": {
+ "wrapped": true
+ },
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Block"
+ }
+ },
+ "UncommittedBlocks": {
+ "xml": {
+ "wrapped": true
+ },
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Block"
+ }
+ }
+ }
+ },
+ "BlockLookupList": {
+ "type": "object",
+ "properties": {
+ "Committed": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "xml": {
+ "name": "Committed"
+ }
+ }
+ },
+ "Uncommitted": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "xml": {
+ "name": "Uncommitted"
+ }
+ }
+ },
+ "Latest": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "xml": {
+ "name": "Latest"
+ }
+ }
+ }
+ },
+ "xml": {
+ "name": "BlockList"
+ }
+ },
+ "ContainerItem": {
+ "xml": {
+ "name": "Container"
+ },
+ "type": "object",
+ "required": [
+ "Name",
+ "Properties"
+ ],
+ "description": "An Azure Storage container",
+ "properties": {
+ "Name": {
+ "type": "string"
+ },
+ "Deleted": {
+ "type": "boolean"
+ },
+ "Version": {
+ "type": "string"
+ },
+ "Properties": {
+ "$ref": "#/definitions/ContainerProperties"
+ },
+ "Metadata": {
+ "$ref": "#/definitions/ContainerMetadata"
+ }
+ }
+ },
+ "ContainerProperties": {
+ "type": "object",
+ "required": [
+ "Last-Modified",
+ "Etag"
+ ],
+ "description": "Properties of a container",
+ "properties": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123"
+ },
+ "Etag": {
+ "type": "string",
+ "format": "etag"
+ },
+ "LeaseStatus": {
+ "$ref": "#/definitions/LeaseStatus"
+ },
+ "LeaseState": {
+ "$ref": "#/definitions/LeaseState"
+ },
+ "LeaseDuration": {
+ "$ref": "#/definitions/LeaseDuration"
+ },
+ "PublicAccess": {
+ "$ref": "#/definitions/PublicAccessType"
+ },
+ "HasImmutabilityPolicy": {
+ "type": "boolean"
+ },
+ "HasLegalHold": {
+ "type": "boolean"
+ },
+ "DeletedTime": {
+ "type": "string",
+ "format": "date-time-rfc1123"
+ },
+ "RemainingRetentionDays": {
+ "type": "integer"
+ }
+ }
+ },
+ "ListContainersSegmentResponse": {
+ "xml": {
+ "name": "EnumerationResults"
+ },
+ "description": "An enumeration of containers",
+ "type": "object",
+ "required": [
+ "ServiceEndpoint",
+ "ContainerItems"
+ ],
+ "properties": {
+ "ServiceEndpoint": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "Prefix": {
+ "type": "string"
+ },
+ "Marker": {
+ "type": "string"
+ },
+ "MaxResults": {
+ "type": "integer"
+ },
+ "ContainerItems": {
+ "xml": {
+ "wrapped": true,
+ "name": "Containers"
+ },
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContainerItem"
+ }
+ },
+ "NextMarker": {
+ "type": "string"
+ }
+ }
+ },
+ "CorsRule": {
+ "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain",
+ "type": "object",
+ "required": [
+ "AllowedOrigins",
+ "AllowedMethods",
+ "AllowedHeaders",
+ "ExposedHeaders",
+ "MaxAgeInSeconds"
+ ],
+ "properties": {
+ "AllowedOrigins": {
+ "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.",
+ "type": "string"
+ },
+ "AllowedMethods": {
+ "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)",
+ "type": "string"
+ },
+ "AllowedHeaders": {
+ "description": "the request headers that the origin domain may specify on the CORS request.",
+ "type": "string"
+ },
+ "ExposedHeaders": {
+ "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer",
+ "type": "string"
+ },
+ "MaxAgeInSeconds": {
+ "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.",
+ "type": "integer",
+ "minimum": 0
+ }
+ }
+ },
+ "ErrorCode": {
+ "description": "Error codes returned by the service",
+ "type": "string",
+ "enum": [
+ "AccountAlreadyExists",
+ "AccountBeingCreated",
+ "AccountIsDisabled",
+ "AuthenticationFailed",
+ "ConditionHeadersNotSupported",
+ "ConditionNotMet",
+ "EmptyMetadataKey",
+ "InsufficientAccountPermissions",
+ "InternalError",
+ "InvalidAuthenticationInfo",
+ "InvalidHeaderValue",
+ "InvalidHttpVerb",
+ "InvalidInput",
+ "InvalidMd5",
+ "InvalidMetadata",
+ "InvalidQueryParameterValue",
+ "InvalidRange",
+ "InvalidResourceName",
+ "InvalidUri",
+ "InvalidXmlDocument",
+ "InvalidXmlNodeValue",
+ "Md5Mismatch",
+ "MetadataTooLarge",
+ "MissingContentLengthHeader",
+ "MissingRequiredQueryParameter",
+ "MissingRequiredHeader",
+ "MissingRequiredXmlNode",
+ "MultipleConditionHeadersNotSupported",
+ "OperationTimedOut",
+ "OutOfRangeInput",
+ "OutOfRangeQueryParameterValue",
+ "RequestBodyTooLarge",
+ "ResourceTypeMismatch",
+ "RequestUrlFailedToParse",
+ "ResourceAlreadyExists",
+ "ResourceNotFound",
+ "ServerBusy",
+ "UnsupportedHeader",
+ "UnsupportedXmlNode",
+ "UnsupportedQueryParameter",
+ "UnsupportedHttpVerb",
+ "AppendPositionConditionNotMet",
+ "BlobAlreadyExists",
+ "BlobNotFound",
+ "BlobOverwritten",
+ "BlobTierInadequateForContentLength",
+ "BlockCountExceedsLimit",
+ "BlockListTooLong",
+ "CannotChangeToLowerTier",
+ "CannotVerifyCopySource",
+ "ContainerAlreadyExists",
+ "ContainerBeingDeleted",
+ "ContainerDisabled",
+ "ContainerNotFound",
+ "ConcurrentContainerOperationInProgress",
+ "DeletedContainerNotFound",
+ "ContentLengthLargerThanTierLimit",
+ "CopyAcrossAccountsNotSupported",
+ "CopyIdMismatch",
+ "FeatureVersionMismatch",
+ "IncrementalCopyBlobMismatch",
+ "IncrementalCopyOfEralierVersionSnapshotNotAllowed",
+ "IncrementalCopySourceMustBeSnapshot",
+ "InfiniteLeaseDurationRequired",
+ "InvalidBlobOrBlock",
+ "InvalidBlobTier",
+ "InvalidBlobType",
+ "InvalidBlockId",
+ "InvalidBlockList",
+ "InvalidOperation",
+ "InvalidPageRange",
+ "InvalidSourceBlobType",
+ "InvalidSourceBlobUrl",
+ "InvalidVersionForPageBlobOperation",
+ "LeaseAlreadyPresent",
+ "LeaseAlreadyBroken",
+ "LeaseIdMismatchWithBlobOperation",
+ "LeaseIdMismatchWithContainerOperation",
+ "LeaseIdMismatchWithLeaseOperation",
+ "LeaseIdMissing",
+ "LeaseIsBreakingAndCannotBeAcquired",
+ "LeaseIsBreakingAndCannotBeChanged",
+ "LeaseIsBrokenAndCannotBeRenewed",
+ "LeaseLost",
+ "LeaseNotPresentWithBlobOperation",
+ "LeaseNotPresentWithContainerOperation",
+ "LeaseNotPresentWithLeaseOperation",
+ "MaxBlobSizeConditionNotMet",
+ "NoPendingCopyOperation",
+ "OperationNotAllowedOnIncrementalCopyBlob",
+ "PendingCopyOperation",
+ "PreviousSnapshotCannotBeNewer",
+ "PreviousSnapshotNotFound",
+ "PreviousSnapshotOperationNotSupported",
+ "SequenceNumberConditionNotMet",
+ "SequenceNumberIncrementTooLarge",
+ "SnapshotCountExceeded",
+ "SnaphotOperationRateExceeded",
+ "SnapshotsPresent",
+ "SourceConditionNotMet",
+ "SystemInUse",
+ "TargetConditionNotMet",
+ "UnauthorizedBlobOverwrite",
+ "BlobBeingRehydrated",
+ "BlobArchived",
+ "BlobNotArchived"
+ ],
+ "x-ms-enum": {
+ "name": "StorageErrorCode",
+ "modelAsString": true
+ }
+ },
+ "FilterBlobsItem": {
+ "xml": {
+ "name": "Blob"
+ },
+ "type": "object",
+ "properties": {
+ "Name": {
+ "type": "string"
+ },
+ "ContainerName": {
+ "type": "string"
+ },
+ "TagValue": {
+ "type": "string"
+ }
+ }
+ },
+ "FilterBlobsSegment": {
+ "xml": {
+ "name": "Blobs"
+ },
+ "type": "object",
+ "properties": {
+ "BlobItems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FilterBlobsItem"
+ }
+ }
+ }
+ },
+ "FilterBlobsResponse": {
+ "xml": {
+ "name": "EnumerationResults"
+ },
+ "description": "An enumeration of blobs which matched the filter.",
+ "type": "object",
+ "required": [
+ "ServiceEndpoint",
+ "Filter",
+ "Segment",
+ "NextMarker"
+ ],
+ "properties": {
+ "ServiceEndpoint": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "Filter": {
+ "type": "string"
+ },
+ "Marker": {
+ "type": "string"
+ },
+ "MaxResults": {
+ "type": "integer"
+ },
+ "Segment": {
+ "$ref": "#/definitions/FilterBlobsSegment"
+ },
+ "NextMarker": {
+ "type": "string"
+ }
+ }
+ },
+ "GeoReplication": {
+ "description": "Geo-Replication information for the Secondary Storage Service",
+ "type": "object",
+ "required": [
+ "Status",
+ "LastSyncTime"
+ ],
+ "properties": {
+ "Status": {
+ "description": "The status of the secondary location",
+ "type": "string",
+ "enum": [
+ "live",
+ "bootstrap",
+ "unavailable"
+ ],
+ "x-ms-enum": {
+ "name": "GeoReplicationStatusType",
+ "modelAsString": true
+ }
+ },
+ "LastSyncTime": {
+ "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ }
+ },
+ "Logging": {
+ "description": "Azure Analytics Logging settings.",
+ "type": "object",
+ "required": [
+ "Version",
+ "Delete",
+ "Read",
+ "Write",
+ "RetentionPolicy"
+ ],
+ "properties": {
+ "Version": {
+ "description": "The version of Storage Analytics to configure.",
+ "type": "string"
+ },
+ "Delete": {
+ "description": "Indicates whether all delete requests should be logged.",
+ "type": "boolean"
+ },
+ "Read": {
+ "description": "Indicates whether all read requests should be logged.",
+ "type": "boolean"
+ },
+ "Write": {
+ "description": "Indicates whether all write requests should be logged.",
+ "type": "boolean"
+ },
+ "RetentionPolicy": {
+ "$ref": "#/definitions/RetentionPolicy"
+ }
+ }
+ },
+ "ContainerMetadata": {
+ "type": "object",
+ "xml": {
+ "name": "Metadata"
+ },
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "BlobMetadata": {
+ "type": "object",
+ "xml": {
+ "name": "Metadata"
+ },
+ "properties": {
+ "Encrypted": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ }
+ },
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "Metrics": {
+ "description": "a summary of request statistics grouped by API in hour or minute aggregates for blobs",
+ "required": [
+ "Enabled"
+ ],
+ "properties": {
+ "Version": {
+ "description": "The version of Storage Analytics to configure.",
+ "type": "string"
+ },
+ "Enabled": {
+ "description": "Indicates whether metrics are enabled for the Blob service.",
+ "type": "boolean"
+ },
+ "IncludeAPIs": {
+ "description": "Indicates whether metrics should generate summary statistics for called API operations.",
+ "type": "boolean"
+ },
+ "RetentionPolicy": {
+ "$ref": "#/definitions/RetentionPolicy"
+ }
+ }
+ },
+ "PageList": {
+ "description": "the list of pages",
+ "type": "object",
+ "properties": {
+ "PageRange": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PageRange"
+ }
+ },
+ "ClearRange": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ClearRange"
+ }
+ }
+ }
+ },
+ "PageRange": {
+ "type": "object",
+ "required": [
+ "Start",
+ "End"
+ ],
+ "properties": {
+ "Start": {
+ "type": "integer",
+ "format": "int64",
+ "xml": {
+ "name": "Start"
+ }
+ },
+ "End": {
+ "type": "integer",
+ "format": "int64",
+ "xml": {
+ "name": "End"
+ }
+ }
+ },
+ "xml": {
+ "name": "PageRange"
+ }
+ },
+ "ClearRange": {
+ "type": "object",
+ "required": [
+ "Start",
+ "End"
+ ],
+ "properties": {
+ "Start": {
+ "type": "integer",
+ "format": "int64",
+ "xml": {
+ "name": "Start"
+ }
+ },
+ "End": {
+ "type": "integer",
+ "format": "int64",
+ "xml": {
+ "name": "End"
+ }
+ }
+ },
+ "xml": {
+ "name": "ClearRange"
+ }
+ },
+ "RetentionPolicy": {
+ "description": "the retention policy which determines how long the associated data should persist",
+ "type": "object",
+ "required": [
+ "Enabled"
+ ],
+ "properties": {
+ "Enabled": {
+ "description": "Indicates whether a retention policy is enabled for the storage service",
+ "type": "boolean"
+ },
+ "Days": {
+ "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted",
+ "type": "integer",
+ "minimum": 1
+ }
+ }
+ },
+ "SignedIdentifier": {
+ "xml": {
+ "name": "SignedIdentifier"
+ },
+ "description": "signed identifier",
+ "type": "object",
+ "required": [
+ "Id",
+ "AccessPolicy"
+ ],
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "a unique id"
+ },
+ "AccessPolicy": {
+ "$ref": "#/definitions/AccessPolicy"
+ }
+ }
+ },
+ "SignedIdentifiers": {
+ "description": "a collection of signed identifiers",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SignedIdentifier"
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "SignedIdentifiers"
+ }
+ },
+ "StaticWebsite": {
+ "description": "The properties that enable an account to host a static website",
+ "type": "object",
+ "required": [
+ "Enabled"
+ ],
+ "properties": {
+ "Enabled": {
+ "description": "Indicates whether this account is hosting a static website",
+ "type": "boolean"
+ },
+ "IndexDocument": {
+ "description": "The default name of the index page under each directory",
+ "type": "string"
+ },
+ "ErrorDocument404Path": {
+ "description": "The absolute path of the custom 404 page",
+ "type": "string"
+ }
+ }
+ },
+ "StorageServiceProperties": {
+ "description": "Storage Service Properties.",
+ "type": "object",
+ "properties": {
+ "Logging": {
+ "$ref": "#/definitions/Logging"
+ },
+ "HourMetrics": {
+ "$ref": "#/definitions/Metrics"
+ },
+ "MinuteMetrics": {
+ "$ref": "#/definitions/Metrics"
+ },
+ "Cors": {
+ "description": "The set of CORS rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CorsRule"
+ },
+ "xml": {
+ "wrapped": true
+ }
+ },
+ "DefaultServiceVersion": {
+ "description": "The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions",
+ "type": "string"
+ },
+ "DeleteRetentionPolicy": {
+ "$ref": "#/definitions/RetentionPolicy"
+ },
+ "StaticWebsite": {
+ "$ref": "#/definitions/StaticWebsite"
+ }
+ }
+ },
+ "StorageServiceStats": {
+ "description": "Stats for the storage service.",
+ "type": "object",
+ "properties": {
+ "GeoReplication": {
+ "$ref": "#/definitions/GeoReplication"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "Url": {
+ "name": "url",
+ "description": "The URL of the service account, container, or blob that is the targe of the desired operation.",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true
+ },
+ "ApiVersionParameter": {
+ "name": "x-ms-version",
+ "x-ms-client-name": "version",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "description": "Specifies the version of the operation to use for this request.",
+ "enum": [
+ "2019-02-02"
+ ]
+ },
+ "Blob": {
+ "name": "blob",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9]+(?:/[a-zA-Z0-9]+)*(?:\\.[a-zA-Z0-9]+){0,1}$",
+ "minLength": 1,
+ "maxLength": 1024,
+ "x-ms-parameter-location": "method",
+ "description": "The blob name."
+ },
+ "Filesystem": {
+ "name": "filesystem",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The filesystem name."
+ },
+ "Path": {
+ "name": "path",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The namespace path to a file or directory."
+ },
+ "BlobCacheControl": {
+ "name": "x-ms-blob-cache-control",
+ "x-ms-client-name": "blobCacheControl",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "blob-HTTP-headers"
+ },
+ "description": "Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request."
+ },
+ "BlobConditionAppendPos": {
+ "name": "x-ms-blob-condition-appendpos",
+ "x-ms-client-name": "appendPosition",
+ "in": "header",
+ "required": false,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "append-position-access-conditions"
+ },
+ "description": "Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed)."
+ },
+ "BlobConditionMaxSize": {
+ "name": "x-ms-blob-condition-maxsize",
+ "x-ms-client-name": "maxSize",
+ "in": "header",
+ "required": false,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "append-position-access-conditions"
+ },
+ "description": "Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed)."
+ },
+ "BlobPublicAccess": {
+ "name": "x-ms-blob-public-access",
+ "x-ms-client-name": "access",
+ "in": "header",
+ "required": false,
+ "x-ms-parameter-location": "method",
+ "description": "Specifies whether data in the container may be accessed publicly and the level of access",
+ "type": "string",
+ "enum": [
+ "container",
+ "blob"
+ ],
+ "x-ms-enum": {
+ "name": "PublicAccessType",
+ "modelAsString": true
+ }
+ },
+ "AccessTierRequired": {
+ "name": "x-ms-access-tier",
+ "x-ms-client-name": "tier",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "P4",
+ "P6",
+ "P10",
+ "P20",
+ "P30",
+ "P40",
+ "P50",
+ "Hot",
+ "Cool",
+ "Archive"
+ ],
+ "x-ms-enum": {
+ "name": "AccessTier",
+ "modelAsString": true
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Indicates the tier to be set on the blob."
+ },
+ "AccessTierOptional": {
+ "name": "x-ms-access-tier",
+ "x-ms-client-name": "tier",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "Hot",
+ "Cool",
+ "Archive"
+ ],
+ "x-ms-enum": {
+ "name": "AccessTier",
+ "modelAsString": true
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Optional. Indicates the tier to be set on the blob."
+ },
+ "RehydratePriority": {
+ "name": "x-ms-rehydrate-priority",
+ "x-ms-client-name": "rehydratePriority",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "High",
+ "Standard"
+ ],
+ "x-ms-enum": {
+ "name": "RehydratePriority",
+ "modelAsString": true
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Optional: Indicates the priority with which to rehydrate an archived blob."
+ },
+ "BlobContentDisposition": {
+ "name": "x-ms-blob-content-disposition",
+ "x-ms-client-name": "blobContentDisposition",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "blob-HTTP-headers"
+ },
+ "description": "Optional. Sets the blob's Content-Disposition header."
+ },
+ "BlobContentEncoding": {
+ "name": "x-ms-blob-content-encoding",
+ "x-ms-client-name": "blobContentEncoding",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "blob-HTTP-headers"
+ },
+ "description": "Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request."
+ },
+ "BlobContentLanguage": {
+ "name": "x-ms-blob-content-language",
+ "x-ms-client-name": "blobContentLanguage",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "blob-HTTP-headers"
+ },
+ "description": "Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request."
+ },
+ "BlobContentLengthOptional": {
+ "name": "x-ms-blob-content-length",
+ "x-ms-client-name": "blobContentLength",
+ "in": "header",
+ "required": false,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method",
+ "description": "This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary."
+ },
+ "BlobContentLengthRequired": {
+ "name": "x-ms-blob-content-length",
+ "x-ms-client-name": "blobContentLength",
+ "in": "header",
+ "required": true,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method",
+ "description": "This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary."
+ },
+ "BlobContentMD5": {
+ "name": "x-ms-blob-content-md5",
+ "x-ms-client-name": "blobContentMD5",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "blob-HTTP-headers"
+ },
+ "description": "Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded."
+ },
+ "BlobContentType": {
+ "name": "x-ms-blob-content-type",
+ "x-ms-client-name": "blobContentType",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "blob-HTTP-headers"
+ },
+ "description": "Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request."
+ },
+ "BlobSequenceNumber": {
+ "name": "x-ms-blob-sequence-number",
+ "x-ms-client-name": "blobSequenceNumber",
+ "in": "header",
+ "required": false,
+ "type": "integer",
+ "format": "int64",
+ "default": 0,
+ "x-ms-parameter-location": "method",
+ "description": "Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1."
+ },
+ "BlobTagsBody": {
+ "name": "Tags",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BlobTags"
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "BlobTagsHeader": {
+ "name": "x-ms-tags",
+ "x-ms-client-name": "tags",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags."
+ },
+ "BlobTagFilter": {
+ "name": "filter",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "x-m-parameter-location": "method",
+ "description": "The filter parameter enables the caller to query blobs whose tags match a given expression. The given expression must evaluate to true for a blob to be returned in the results."
+ },
+ "BlockId": {
+ "name": "blockid",
+ "x-ms-client-name": "blockId",
+ "in": "query",
+ "type": "string",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block."
+ },
+ "BlockListType": {
+ "name": "blocklisttype",
+ "x-ms-client-name": "listType",
+ "in": "query",
+ "required": true,
+ "default": "committed",
+ "x-ms-parameter-location": "method",
+ "description": "Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together.",
+ "type": "string",
+ "enum": [
+ "committed",
+ "uncommitted",
+ "all"
+ ],
+ "x-ms-enum": {
+ "name": "BlockListType",
+ "modelAsString": false
+ }
+ },
+ "Body": {
+ "name": "body",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "format": "file"
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Initial data"
+ },
+ "Continuation": {
+ "name": "continuation",
+ "x-ms-client-name": "marker",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "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."
+ },
+ "ContainerAcl": {
+ "name": "containerAcl",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/SignedIdentifiers"
+ },
+ "x-ms-parameter-location": "method",
+ "description": "the acls for the container"
+ },
+ "CopyId": {
+ "name": "copyid",
+ "x-ms-client-name": "copyId",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation."
+ },
+ "ClientRequestId": {
+ "name": "x-ms-client-request-id",
+ "x-ms-client-name": "requestId",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled."
+ },
+ "ContainerName": {
+ "name": "containerName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The container name."
+ },
+ "ContentCrc64": {
+ "name": "x-ms-content-crc64",
+ "x-ms-client-name": "transactionalContentCrc64",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method",
+ "description": "Specify the transactional crc64 for the body, to be validated by the service."
+ },
+ "ContentLength": {
+ "name": "Content-Length",
+ "in": "header",
+ "required": true,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method",
+ "description": "The length of the request."
+ },
+ "ContentMD5": {
+ "name": "Content-MD5",
+ "x-ms-client-name": "transactionalContentMD5",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method",
+ "description": "Specify the transactional md5 for the body, to be validated by the service."
+ },
+ "CopySource": {
+ "name": "x-ms-copy-source",
+ "x-ms-client-name": "copySource",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "format": "url",
+ "x-ms-parameter-location": "method",
+ "description": "Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature."
+ },
+ "DeletedContainerName": {
+ "name": "x-ms-deleted-container-name",
+ "x-ms-client-name": "deletedContainerName",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Specify the name of the deleted container that should be restored."
+ },
+ "DeletedContainerVersion": {
+ "name": "x-ms-deleted-container-version",
+ "x-ms-client-name": "deletedContainerVersion",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Specify the version of the deleted container that should be restored."
+ },
+ "DeleteSnapshots": {
+ "name": "x-ms-delete-snapshots",
+ "x-ms-client-name": "deleteSnapshots",
+ "description": "Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself",
+ "x-ms-parameter-location": "method",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "include",
+ "only"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteSnapshotsOptionType",
+ "modelAsString": false
+ }
+ },
+ "Delimiter": {
+ "name": "delimiter",
+ "description": "When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.",
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "in": "query",
+ "required": true
+ },
+ "DirectoryProperties": {
+ "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 base64 encoded.",
+ "x-ms-client-name": "directoryProperties",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "EncryptionKey": {
+ "name": "x-ms-encryption-key",
+ "x-ms-client-name": "encryptionKey",
+ "type": "string",
+ "in": "header",
+ "required": false,
+ "x-ms-parameter-location": "method",
+ "description": "Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services."
+ },
+ "EncryptionScope": {
+ "name": "x-ms-encryption-scope",
+ "type": "string",
+ "in": "query",
+ "required": false,
+ "x-ms-client-name": "EncryptionScope",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "customer-provided-key-info"
+ },
+ "description": "Optional. Specifies the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services."
+ },
+ "EncryptionKeySha256": {
+ "name": "x-ms-encryption-key-sha256",
+ "x-ms-client-name": "encryptionKeySha256",
+ "type": "string",
+ "in": "header",
+ "required": false,
+ "x-ms-parameter-location": "method",
+ "description": "The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided."
+ },
+ "EncryptionAlgorithm": {
+ "name": "x-ms-encryption-algorithm",
+ "x-ms-client-name": "encryptionAlgorithm",
+ "type": "string",
+ "in": "header",
+ "required": false,
+ "enum": [
+ "AES256"
+ ],
+ "x-ms-enum": {
+ "name": "EncryptionAlgorithmType",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided."
+ },
+ "DefaultEncryptionScope": {
+ "name": "x-ms-default-encryption-scope",
+ "type": "string",
+ "in": "header",
+ "required": false,
+ "x-ms-client-name": "DefaultEncryptionScope",
+ "x-ms-parameter-location": "method",
+ "description": "Optional. Specifies the default encryption scope on the container. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services."
+ },
+ "DenyEncryptionScopeOverride": {
+ "name": "x-ms-deny-encryption-scope-override",
+ "type": "boolean",
+ "in": "header",
+ "required": false,
+ "x-ms-client-name": "DenyEncryptionScopeOverride",
+ "x-ms-parameter-location": "method",
+ "description": "Optional. Specifies whether to deny encryption scope override provided in the request or not. If true, reject the request with encryption scope. If false, encryption is performed using encryption scope provided in the request. For more information, see Encryption at Rest for Azure Storage Services."
+ },
+ "FileRenameSource": {
+ "name": "x-ms-rename-source",
+ "x-ms-client-name": "renameSource",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The file or directory to be renamed. The value must have the following format: \"/{filesysystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved."
+ },
+ "GetRangeContentMD5": {
+ "name": "x-ms-range-get-content-md5",
+ "x-ms-client-name": "rangeGetContentMD5",
+ "in": "header",
+ "required": false,
+ "type": "boolean",
+ "x-ms-parameter-location": "method",
+ "description": "When set to true and specified together with the Range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size."
+ },
+ "GetRangeContentCRC64": {
+ "name": "x-ms-range-get-content-crc64",
+ "x-ms-client-name": "rangeGetContentCRC64",
+ "in": "header",
+ "required": false,
+ "type": "boolean",
+ "x-ms-parameter-location": "method",
+ "description": "When set to true and specified together with the Range, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size."
+ },
+ "IfMatch": {
+ "name": "If-Match",
+ "x-ms-client-name": "ifMatch",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "etag",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "modified-access-conditions"
+ },
+ "description": "Specify an ETag value to operate only on blobs with a matching value."
+ },
+ "IfModifiedSince": {
+ "name": "If-Modified-Since",
+ "x-ms-client-name": "ifModifiedSince",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "modified-access-conditions"
+ },
+ "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time."
+ },
+ "IfNoneMatch": {
+ "name": "If-None-Match",
+ "x-ms-client-name": "ifNoneMatch",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "etag",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "modified-access-conditions"
+ },
+ "description": "Specify an ETag value to operate only on blobs without a matching value."
+ },
+ "IfUnmodifiedSince": {
+ "name": "If-Unmodified-Since",
+ "x-ms-client-name": "ifUnmodifiedSince",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "modified-access-conditions"
+ },
+ "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time."
+ },
+ "IfSequenceNumberEqualTo": {
+ "name": "x-ms-if-sequence-number-eq",
+ "x-ms-client-name": "ifSequenceNumberEqualTo",
+ "in": "header",
+ "required": false,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "sequence-number-access-conditions"
+ },
+ "description": "Specify this header value to operate only on a blob if it has the specified sequence number."
+ },
+ "IfSequenceNumberLessThan": {
+ "name": "x-ms-if-sequence-number-lt",
+ "x-ms-client-name": "ifSequenceNumberLessThan",
+ "in": "header",
+ "required": false,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "sequence-number-access-conditions"
+ },
+ "description": "Specify this header value to operate only on a blob if it has a sequence number less than the specified."
+ },
+ "IfSequenceNumberLessThanOrEqualTo": {
+ "name": "x-ms-if-sequence-number-le",
+ "x-ms-client-name": "ifSequenceNumberLessThanOrEqualTo",
+ "in": "header",
+ "required": false,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "sequence-number-access-conditions"
+ },
+ "description": "Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified."
+ },
+ "KeyInfo": {
+ "name": "KeyInfo",
+ "in": "body",
+ "x-ms-parameter-location": "method",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ "ListBlobsInclude": {
+ "name": "include",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "collectionFormat": "csv",
+ "items": {
+ "type": "string",
+ "enum": [
+ "copy",
+ "deleted",
+ "metadata",
+ "snapshots",
+ "tags",
+ "uncommittedblobs"
+ ],
+ "x-ms-enum": {
+ "name": "ListBlobsIncludeItem",
+ "modelAsString": false
+ }
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Include this parameter to specify one or more datasets to include in the response."
+ },
+ "ListContainersInclude": {
+ "name": "include",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "deleted",
+ "metadata"
+ ],
+ "x-ms-enum": {
+ "name": "ListContainersIncludeType",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Include this parameter to specify that the container's metadata be returned as part of the response body."
+ },
+ "LeaseBreakPeriod": {
+ "name": "x-ms-lease-break-period",
+ "x-ms-client-name": "breakPeriod",
+ "in": "header",
+ "required": false,
+ "type": "integer",
+ "x-ms-parameter-location": "method",
+ "description": "For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately."
+ },
+ "LeaseDuration": {
+ "name": "x-ms-lease-duration",
+ "x-ms-client-name": "duration",
+ "in": "header",
+ "required": false,
+ "type": "integer",
+ "x-ms-parameter-location": "method",
+ "description": "Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change."
+ },
+ "LeaseIdOptional": {
+ "name": "x-ms-lease-id",
+ "x-ms-client-name": "leaseId",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "lease-access-conditions"
+ },
+ "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID."
+ },
+ "LeaseIdRequired": {
+ "name": "x-ms-lease-id",
+ "x-ms-client-name": "leaseId",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Specifies the current lease ID on the resource."
+ },
+ "Marker": {
+ "name": "marker",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.",
+ "x-ms-parameter-location": "method"
+ },
+ "MaxResults": {
+ "name": "maxresults",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "minimum": 1,
+ "x-ms-parameter-location": "method",
+ "description": "Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000."
+ },
+ "Metadata": {
+ "name": "x-ms-meta",
+ "x-ms-client-name": "metadata",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information.",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "PathRenameMode": {
+ "name": "mode",
+ "x-ms-client-name": "pathRenameMode",
+ "description": "Determines the behavior of the rename operation",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "legacy",
+ "posix"
+ ],
+ "x-ms-enum": {
+ "name": "PathRenameMode",
+ "modelAsString": false
+ }
+ },
+ "PosixPermissions": {
+ "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.",
+ "x-ms-client-name": "posixPermissions",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "PosixUmask": {
+ "name": "x-ms-umask",
+ "x-ms-client-name": "posixUmask",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used."
+ },
+ "Prefix": {
+ "name": "prefix",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Filters the results to return only containers whose name begins with the specified prefix.",
+ "x-ms-parameter-location": "method"
+ },
+ "PrevSnapshot": {
+ "name": "prevsnapshot",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Optional in version 2015-07-08 and newer. The prevsnapshot parameter is a DateTime value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, root blob or version, as long as the snapshot specified by prevsnapshot is the older of the two. Note that incremental snapshots are currently supported only for blobs created on or after January 1, 2016."
+ },
+ "PrevSnapshotUrl": {
+ "name": "x-ms-previous-snapshot-url",
+ "x-ms-client-name": "prevSnapshotUrl",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "url",
+ "x-ms-parameter-location": "method",
+ "description": "Optional in version 2019-04-04 and newer. The prevsnapshoturl header is an url that specifies that the response will contain only pages that were changed between target blob/snapshot/version and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, root blob or version, as long as the snapshot specified by prevsnapshoturl is the older of the two."
+ },
+ "ProposedLeaseIdOptional": {
+ "name": "x-ms-proposed-lease-id",
+ "x-ms-client-name": "proposedLeaseId",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats."
+ },
+ "ProposedLeaseIdRequired": {
+ "name": "x-ms-proposed-lease-id",
+ "x-ms-client-name": "proposedLeaseId",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats."
+ },
+ "Range": {
+ "name": "x-ms-range",
+ "x-ms-client-name": "range",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Return only the bytes of the blob in the specified range."
+ },
+ "RangeRequiredPutPageFromUrl": {
+ "name": "x-ms-range",
+ "x-ms-client-name": "range",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The range of bytes to which the source range would be written. The range should be 512 aligned and range-end is required."
+ },
+ "SourceRangeRequiredPutPageFromUrl": {
+ "name": "x-ms-source-range",
+ "x-ms-client-name": "sourceRange",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Bytes of source data in the specified range. The length of this range should match the ContentLength header and x-ms-range/Range destination range header."
+ },
+ "RecursiveDirectoryDelete": {
+ "name": "recursive",
+ "x-ms-client-name": "recursiveDirectoryDelete",
+ "in": "query",
+ "required": true,
+ "type": "boolean",
+ "x-ms-parameter-location": "method",
+ "description": "If \"true\", all paths beneath the directory will be deleted. If \"false\" and the directory is non-empty, an error occurs."
+ },
+ "SequenceNumberAction": {
+ "name": "x-ms-sequence-number-action",
+ "x-ms-client-name": "sequenceNumberAction",
+ "in": "header",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Required if the x-ms-blob-sequence-number header is set for the request. This property applies to page blobs only. This property indicates how the service should modify the blob's sequence number",
+ "type": "string",
+ "enum": [
+ "max",
+ "update",
+ "increment"
+ ],
+ "x-ms-enum": {
+ "name": "SequenceNumberActionType",
+ "modelAsString": false
+ }
+ },
+ "Snapshot": {
+ "name": "snapshot",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob."
+ },
+ "SourceContentMD5": {
+ "name": "x-ms-source-content-md5",
+ "x-ms-client-name": "sourceContentMD5",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method",
+ "description": "Specify the md5 calculated for the range of bytes that must be read from the copy source."
+ },
+ "SourceContentCRC64": {
+ "name": "x-ms-source-content-crc64",
+ "x-ms-client-name": "sourceContentcrc64",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method",
+ "description": "Specify the crc64 calculated for the range of bytes that must be read from the copy source."
+ },
+ "SourceRange": {
+ "name": "x-ms-source-range",
+ "x-ms-client-name": "sourceRange",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Bytes of source data in the specified range."
+ },
+ "SourceIfMatch": {
+ "name": "x-ms-source-if-match",
+ "x-ms-client-name": "sourceIfMatch",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "etag",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "source-modified-access-conditions"
+ },
+ "description": "Specify an ETag value to operate only on blobs with a matching value."
+ },
+ "SourceIfModifiedSince": {
+ "name": "x-ms-source-if-modified-since",
+ "x-ms-client-name": "sourceIfModifiedSince",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "source-modified-access-conditions"
+ },
+ "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time."
+ },
+ "SourceIfNoneMatch": {
+ "name": "x-ms-source-if-none-match",
+ "x-ms-client-name": "sourceIfNoneMatch",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "etag",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "source-modified-access-conditions"
+ },
+ "description": "Specify an ETag value to operate only on blobs without a matching value."
+ },
+ "SourceIfUnmodifiedSince": {
+ "name": "x-ms-source-if-unmodified-since",
+ "x-ms-client-name": "sourceIfUnmodifiedSince",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "source-modified-access-conditions"
+ },
+ "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time."
+ },
+ "SourceLeaseId": {
+ "name": "x-ms-source-lease-id",
+ "x-ms-client-name": "sourceLeaseId",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "A lease ID for the source path. If specified, the source path must have an active lease and the leaase ID must match."
+ },
+ "SourceUrl": {
+ "name": "x-ms-copy-source",
+ "x-ms-client-name": "sourceUrl",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "format": "url",
+ "x-ms-parameter-location": "method",
+ "description": "Specify a URL to the copy source."
+ },
+ "StorageServiceProperties": {
+ "name": "StorageServiceProperties",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageServiceProperties"
+ },
+ "x-ms-parameter-location": "method",
+ "description": "The StorageService properties."
+ },
+ "Timeout": {
+ "name": "timeout",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "minimum": 0,
+ "x-ms-parameter-location": "method",
+ "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations."
+ },
+ "VersionId": {
+ "name": "versionid",
+ "x-ms-client-name": "versionId",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The version ID parameter is an opaque DateTime value that, when present, specifies the blob version to retrieve."
+ },
+ "XMsCacheControl": {
+ "name": "x-ms-cache-control",
+ "x-ms-client-name": "cacheControl",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "directory-http-headers"
+ },
+ "description": "Cache control for given resource"
+ },
+ "XMsContentType": {
+ "name": "x-ms-content-type",
+ "x-ms-client-name": "contentType",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "directory-http-headers"
+ },
+ "description": "Content type for given resource"
+ },
+ "XMsContentEncoding": {
+ "name": "x-ms-content-encoding",
+ "x-ms-client-name": "contentEncoding",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "directory-http-headers"
+ },
+ "description": "Content encoding for given resource"
+ },
+ "XMsContentLanguage": {
+ "name": "x-ms-content-language",
+ "x-ms-client-name": "contentLanguage",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "directory-http-headers"
+ },
+ "description": "Content language for given resource"
+ },
+ "XMsContentDisposition": {
+ "name": "x-ms-content-disposition",
+ "x-ms-client-name": "contentDisposition",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "directory-http-headers"
+ },
+ "description": "Content disposition for given resource"
+ }
+ }
+}
\ No newline at end of file
diff --git a/samples/Storage.Blobs/readme.md b/samples/Storage.Blobs/readme.md
new file mode 100644
index 00000000..56194f77
--- /dev/null
+++ b/samples/Storage.Blobs/readme.md
@@ -0,0 +1,11 @@
+# Storage
+### AutoRest Configuration
+> see https://aka.ms/autorest
+
+``` yaml
+title: Storage.Blobs
+require:
+- $(this-folder)/../readme.samples.md
+- https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs/swagger/readme.md
+namespace: Azure.Storage.Blobs
+```
\ No newline at end of file
diff --git a/samples/Storage/DataLakeStorage.json b/samples/Storage.DataLake/DataLakeStorage.json
similarity index 100%
rename from samples/Storage/DataLakeStorage.json
rename to samples/Storage.DataLake/DataLakeStorage.json
diff --git a/samples/Storage.DataLake/readme.md b/samples/Storage.DataLake/readme.md
new file mode 100644
index 00000000..4f6c856b
--- /dev/null
+++ b/samples/Storage.DataLake/readme.md
@@ -0,0 +1,11 @@
+# Storage
+### AutoRest Configuration
+> see https://aka.ms/autorest
+
+``` yaml
+title: Storage.DataLake
+require:
+- $(this-folder)/../readme.samples.md
+- https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Files.DataLake/swagger/readme.md
+namespace: Azure.Storage.DataLake
+```
\ No newline at end of file
diff --git a/samples/Storage.Files/file.json b/samples/Storage.Files/file.json
new file mode 100644
index 00000000..a85865e9
--- /dev/null
+++ b/samples/Storage.Files/file.json
@@ -0,0 +1,4452 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Azure File Storage",
+ "version": "2019-07-07",
+ "x-ms-code-generation-settings": {
+ "header": "MIT",
+ "strictSpecAdherence": false
+ }
+ },
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{url}",
+ "useSchemePrefix": false,
+ "positionInOperation": "first",
+ "parameters": [{
+ "$ref": "#/parameters/Url"
+ }]
+ },
+ "securityDefinitions": {
+ "File_shared_key": {
+ "type": "apiKey",
+ "name": "Authorization",
+ "in": "header"
+ }
+ },
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/xml"
+ ],
+ "produces": [
+ "application/xml"
+ ],
+ "paths": {
+
+ },
+ "x-ms-paths": {
+ "/?restype=service&comp=properties": {
+ "put": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_SetProperties",
+ "description": "Sets properties for a storage account's File service endpoint, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.",
+ "parameters": [{
+ "$ref": "#/parameters/StorageServiceProperties"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Success (Accepted)",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_GetProperties",
+ "description": "Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageServiceProperties"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "service"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/?comp=list": {
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_ListSharesSegment",
+ "description": "The List Shares Segment operation returns a list of the shares and share snapshots under the specified account.",
+ "parameters": [{
+ "$ref": "#/parameters/Prefix"
+ },
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/MaxResults"
+ },
+ {
+ "$ref": "#/parameters/ListSharesInclude"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/ListSharesResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "NextMarker"
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "list"
+ ]
+ }]
+ },
+ "/{shareName}?restype=share": {
+ "put": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_Create",
+ "description": "Creates a new share under the specified account. If the share with the same name already exists, the operation fails.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/EnabledProtocols"
+ },
+ {
+ "$ref": "#/parameters/RootSquash"
+ },
+ {
+ "$ref": "#/parameters/ShareQuota"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success, Share created.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the share, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_GetProperties",
+ "description": "Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files.",
+ "parameters": [{
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "x-ms-meta": {
+ "type": "string",
+ "description": "A set of name-value pairs that contain the user-defined metadata of the share.",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-share-quota": {
+ "x-ms-client-name": "Quota",
+ "type": "integer",
+ "description": "Returns the current share quota in GB."
+ },
+ "x-ms-enabled-protocols": {
+ "x-ms-client-name": "EnabledProtocols",
+ "type": "string",
+ "description": "Returns the the protocols enabled on the share."
+ },
+ "x-ms-root-squash": {
+ "x-ms-client-name": "RootSquash",
+ "type": "string",
+ "description": "Returns the user ID mapping option of the share."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_Delete",
+ "description": "Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection.",
+ "parameters": [{
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/DeleteSnapshots"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "share"
+ ]
+ }]
+ },
+ "/{shareName}?restype=share&comp=snapshot": {
+ "put": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_CreateSnapshot",
+ "description": "Creates a read-only snapshot of a share.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success, Share snapshot created.",
+ "headers": {
+ "x-ms-snapshot": {
+ "x-ms-client-name": "Snapshot",
+ "type": "string",
+ "description": "This header is a DateTime value that uniquely identifies the share snapshot. The value of this header may be used in subsequent requests to access the share snapshot. This value is opaque."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the share snapshot, in quotes. A share snapshot cannot be modified, so the ETag of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the ETag of the share snapshot differs from that of the base share. If no metadata was specified with the request, the ETag of the share snapshot is identical to that of the base share at the time the share snapshot was taken."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. A share snapshot cannot be modified, so the last modified time of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the last modified time of the share snapshot differs from that of the base share. If no metadata was specified with the request, the last modified time of the share snapshot is identical to that of the base share at the time the share snapshot was taken."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "share"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "snapshot"
+ ]
+ }
+ ]
+ },
+ "/{shareName}?restype=share&comp=filepermission": {
+ "put": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_CreatePermission",
+ "description": "Create a permission (a security descriptor).",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success, Share level permission created.",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-file-permission-key": {
+ "x-ms-client-name": "FilePermissionKey",
+ "type": "string",
+ "description": "Key of the permission set for the directory/file."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_GetPermission",
+ "description": "Returns the permission (security descriptor) for a given key",
+ "parameters": [{
+ "$ref": "#/parameters/FilePermissionKey"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "share"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "filepermission"
+ ]
+ }
+ ]
+ },
+ "/{shareName}?restype=share&comp=properties": {
+ "put": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_SetProperties",
+ "description": "Sets properties for the specified share.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ShareQuota"
+ },
+ {
+ "$ref": "#/parameters/RootSquash"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "share"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/{shareName}?restype=share&comp=metadata": {
+ "put": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_SetMetadata",
+ "description": "Sets one or more user-defined name-value pairs for the specified share.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "share"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "metadata"
+ ]
+ }
+ ]
+ },
+ "/{shareName}?restype=share&comp=acl": {
+ "get": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_GetAccessPolicy",
+ "description": "Returns information about stored access policies specified on the share.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/SignedIdentifiers"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_SetAccessPolicy",
+ "description": "Sets a stored access policy for use with shared access signatures.",
+ "parameters": [{
+ "$ref": "#/parameters/ShareAcl"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "share"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "acl"
+ ]
+ }
+ ]
+ },
+ "/{shareName}?restype=share&comp=stats": {
+ "get": {
+ "tags": [
+ "share"
+ ],
+ "operationId": "Share_GetStatistics",
+ "description": "Retrieves statistics related to the share.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/ShareStats"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "share"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "stats"
+ ]
+ }
+ ]
+ },
+ "/{shareName}/{directory}?restype=directory": {
+ "put": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_Create",
+ "description": "Creates a new directory under the specified share or parent directory.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilePermission"
+ },
+ {
+ "$ref": "#/parameters/FilePermissionKey"
+ },
+ {
+ "$ref": "#/parameters/FileAttributes"
+ },
+ {
+ "$ref": "#/parameters/FileCreationTime"
+ },
+ {
+ "$ref": "#/parameters/FileLastWriteTime"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success, Directory created.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the directory, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-file-permission-key": {
+ "x-ms-client-name": "FilePermissionKey",
+ "type": "string",
+ "description": "Key of the permission set for the directory."
+ },
+ "x-ms-file-attributes": {
+ "x-ms-client-name": "FileAttributes",
+ "type": "string",
+ "description": "Attributes set for the directory."
+ },
+ "x-ms-file-creation-time": {
+ "x-ms-client-name": "FileCreationTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Creation time for the directory."
+ },
+ "x-ms-file-last-write-time": {
+ "x-ms-client-name": "FileLastWriteTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last write time for the directory."
+ },
+ "x-ms-file-change-time": {
+ "x-ms-client-name": "FileChangeTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Change time for the directory."
+ },
+ "x-ms-file-id": {
+ "x-ms-client-name": "FileId",
+ "type": "string",
+ "description": "The fileId of the directory."
+ },
+ "x-ms-file-parent-id": {
+ "x-ms-client-name": "FileParentId",
+ "type": "string",
+ "description": "The parent fileId of the directory."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_GetProperties",
+ "description": "Returns all system properties for the specified directory, and can also be used to check the existence of a directory. The data returned does not include the files in the directory or any subdirectories.",
+ "parameters": [{
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-meta": {
+ "type": "string",
+ "description": "A set of name-value pairs that contain metadata for the directory.",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false."
+ },
+ "x-ms-file-attributes": {
+ "x-ms-client-name": "FileAttributes",
+ "type": "string",
+ "description": "Attributes set for the directory."
+ },
+ "x-ms-file-creation-time": {
+ "x-ms-client-name": "FileCreationTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Creation time for the directory."
+ },
+ "x-ms-file-last-write-time": {
+ "x-ms-client-name": "FileLastWriteTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last write time for the directory."
+ },
+ "x-ms-file-change-time": {
+ "x-ms-client-name": "FileChangeTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Change time for the directory."
+ },
+ "x-ms-file-permission-key": {
+ "x-ms-client-name": "FilePermissionKey",
+ "type": "string",
+ "description": "Key of the permission set for the directory."
+ },
+ "x-ms-file-id": {
+ "x-ms-client-name": "FileId",
+ "type": "string",
+ "description": "The fileId of the directory."
+ },
+ "x-ms-file-parent-id": {
+ "x-ms-client-name": "FileParentId",
+ "type": "string",
+ "description": "The parent fileId of the directory."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_Delete",
+ "description": "Removes the specified empty directory. Note that the directory must be empty before it can be deleted.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Success (Accepted).",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "directory"
+ ]
+ }]
+ },
+ "/{shareName}/{directory}?restype=directory&comp=properties": {
+ "put": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_SetProperties",
+ "description": "Sets properties on the directory.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilePermission"
+ },
+ {
+ "$ref": "#/parameters/FilePermissionKey"
+ },
+ {
+ "$ref": "#/parameters/FileAttributes"
+ },
+ {
+ "$ref": "#/parameters/FileCreationTime"
+ },
+ {
+ "$ref": "#/parameters/FileLastWriteTime"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the file, in quotes."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-file-permission-key": {
+ "x-ms-client-name": "FilePermissionKey",
+ "type": "string",
+ "description": "Key of the permission set for the directory."
+ },
+ "x-ms-file-attributes": {
+ "x-ms-client-name": "FileAttributes",
+ "type": "string",
+ "description": "Attributes set for the directory."
+ },
+ "x-ms-file-creation-time": {
+ "x-ms-client-name": "FileCreationTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Creation time for the directory."
+ },
+ "x-ms-file-last-write-time": {
+ "x-ms-client-name": "FileLastWriteTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last write time for the directory."
+ },
+ "x-ms-file-change-time": {
+ "x-ms-client-name": "FileChangeTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Change time for the directory."
+ },
+ "x-ms-file-id": {
+ "x-ms-client-name": "FileId",
+ "type": "string",
+ "description": "The fileId of the directory."
+ },
+ "x-ms-file-parent-id": {
+ "x-ms-client-name": "FileParentId",
+ "type": "string",
+ "description": "The parent fileId of the directory."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "directory"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/{shareName}/{directory}?restype=directory&comp=metadata": {
+ "put": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_SetMetadata",
+ "description": "Updates user defined metadata for the specified directory.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success (OK).",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the directory, in quotes."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "directory"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "metadata"
+ ]
+ }
+ ]
+ },
+ "/{shareName}/{directory}?restype=directory&comp=list": {
+ "get": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_ListFilesAndDirectoriesSegment",
+ "description": "Returns a list of files or directories under the specified share or directory. It lists the contents only for a single level of the directory hierarchy.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Prefix"
+ },
+ {
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/MaxResults"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "Content-Type": {
+ "type": "string",
+ "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/ListFilesAndDirectoriesSegmentResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "NextMarker"
+ }
+ },
+ "parameters": [{
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "directory"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "list"
+ ]
+ }
+ ]
+ },
+ "/{shareName}/{directory}?comp=listhandles": {
+ "get":{
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_ListHandles",
+ "description": "Lists handles for directory.",
+ "parameters":[
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/MaxResults"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/Recursive"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "Content-Type": {
+ "type": "string",
+ "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/ListHandlesResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "listhandles"
+ ]
+ }
+ ]
+ },
+ "/{shareName}/{directory}?comp=forceclosehandles": {
+ "put": {
+ "tags": [
+ "directory"
+ ],
+ "operationId": "Directory_ForceCloseHandles",
+ "description": "Closes all handles open for given directory.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/HandleId"
+ },
+ {
+ "$ref": "#/parameters/Recursive"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-marker": {
+ "x-ms-client-name": "marker",
+ "type": "string",
+ "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request."
+ },
+ "x-ms-number-of-handles-closed": {
+ "x-ms-client-name": "numberOfHandlesClosed",
+ "type": "integer",
+ "description": "Contains count of number of handles closed."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "forceclosehandles"
+ ]
+ }
+ ]
+ },
+ "/{shareName}/{directory}/{fileName}": {
+ "put": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_Create",
+ "description": "Creates a new file or replaces a file. Note it only initializes the file with no content.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "x-ms-content-length",
+ "x-ms-client-name": "fileContentLength",
+ "in": "header",
+ "description": "Specifies the maximum size for the file, up to 1 TB.",
+ "required": true,
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "$ref": "#/parameters/FileType"
+ },
+ {
+ "$ref": "#/parameters/FileContentType"
+ },
+ {
+ "$ref": "#/parameters/FileContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/FileContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/FileCacheControl"
+ },
+ {
+ "$ref": "#/parameters/FileContentMD5"
+ },
+ {
+ "$ref": "#/parameters/FileContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/FilePermission"
+ },
+ {
+ "$ref": "#/parameters/FilePermissionKey"
+ },
+ {
+ "$ref": "#/parameters/FileAttributes"
+ },
+ {
+ "$ref": "#/parameters/FileCreationTime"
+ },
+ {
+ "$ref": "#/parameters/FileLastWriteTime"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success, File created.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the file, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-file-permission-key": {
+ "x-ms-client-name": "FilePermissionKey",
+ "type": "string",
+ "description": "Key of the permission set for the file."
+ },
+ "x-ms-file-attributes": {
+ "x-ms-client-name": "FileAttributes",
+ "type": "string",
+ "description": "Attributes set for the file."
+ },
+ "x-ms-file-creation-time": {
+ "x-ms-client-name": "FileCreationTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Creation time for the file."
+ },
+ "x-ms-file-last-write-time": {
+ "x-ms-client-name": "FileLastWriteTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last write time for the file."
+ },
+ "x-ms-file-change-time": {
+ "x-ms-client-name": "FileChangeTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Change time for the file."
+ },
+ "x-ms-file-id": {
+ "x-ms-client-name": "FileId",
+ "type": "string",
+ "description": "The fileId of the file."
+ },
+ "x-ms-file-parent-id": {
+ "x-ms-client-name": "FileParentId",
+ "type": "string",
+ "description": "The parent fileId of the file."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_Download",
+ "description": "Reads or downloads a file from the system, including its metadata and properties.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/Range"
+ },
+ {
+ "$ref": "#/parameters/GetRangeContentMD5"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Succeeded to read the entire file.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time."
+ },
+ "x-ms-meta": {
+ "type": "string",
+ "description": "A set of name-value pairs associated with this file as user-defined metadata.",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of bytes present in the response body."
+ },
+ "Content-Type": {
+ "type": "string",
+ "description": "The content type specified for the file. The default content type is 'application/octet-stream'"
+ },
+ "Content-Range": {
+ "type": "string",
+ "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. 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. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header."
+ },
+ "Content-Encoding": {
+ "type": "string",
+ "description": "Returns the value that was specified for the Content-Encoding request header."
+ },
+ "Cache-Control": {
+ "type": "string",
+ "description": "Returned if it was previously specified for the file."
+ },
+ "Content-Disposition": {
+ "type": "string",
+ "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response."
+ },
+ "Content-Language": {
+ "type": "string",
+ "description": "Returns the value that was specified for the Content-Language request header."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Accept-Ranges": {
+ "type": "string",
+ "description": "Indicates that the service supports requests for partial file content."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-copy-completion-time": {
+ "x-ms-client-name": "CopyCompletionTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt."
+ },
+ "x-ms-copy-status-description": {
+ "x-ms-client-name": "CopyStatusDescription",
+ "type": "string",
+ "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure."
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for the last attempted Copy File operation where this file was the destination file."
+ },
+ "x-ms-copy-progress": {
+ "x-ms-client-name": "CopyProgress",
+ "type": "string",
+ "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied."
+ },
+ "x-ms-copy-source": {
+ "x-ms-client-name": "CopySource",
+ "type": "string",
+ "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by 'x-ms-copy-id'.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-content-md5": {
+ "x-ms-client-name": "FileContentMD5",
+ "type": "string",
+ "format": "byte",
+ "description": "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 whole 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."
+ },
+ "x-ms-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)."
+ },
+ "x-ms-file-attributes": {
+ "x-ms-client-name": "FileAttributes",
+ "type": "string",
+ "description": "Attributes set for the file."
+ },
+ "x-ms-file-creation-time": {
+ "x-ms-client-name": "FileCreationTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Creation time for the file."
+ },
+ "x-ms-file-last-write-time": {
+ "x-ms-client-name": "FileLastWriteTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last write time for the file."
+ },
+ "x-ms-file-change-time": {
+ "x-ms-client-name": "FileChangeTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Change time for the file."
+ },
+ "x-ms-file-permission-key": {
+ "x-ms-client-name": "FilePermissionKey",
+ "type": "string",
+ "description": "Key of the permission set for the file."
+ },
+ "x-ms-file-id": {
+ "x-ms-client-name": "FileId",
+ "type": "string",
+ "description": "The fileId of the file."
+ },
+ "x-ms-file-parent-id": {
+ "x-ms-client-name": "FileParentId",
+ "type": "string",
+ "description": "The parent fileId of the file."
+ }
+ },
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ },
+ "206": {
+ "description": "Succeeded to read a specified range of the file.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time."
+ },
+ "x-ms-meta": {
+ "type": "string",
+ "description": "A set of name-value pairs associated with this file as user-defined metadata.",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of bytes present in the response body."
+ },
+ "Content-Type": {
+ "type": "string",
+ "description": "The content type specified for the file. The default content type is 'application/octet-stream'"
+ },
+ "Content-Range": {
+ "type": "string",
+ "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. 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. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header."
+ },
+ "Content-Encoding": {
+ "type": "string",
+ "description": "Returns the value that was specified for the Content-Encoding request header."
+ },
+ "Cache-Control": {
+ "type": "string",
+ "description": "Returned if it was previously specified for the file."
+ },
+ "Content-Disposition": {
+ "type": "string",
+ "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response."
+ },
+ "Content-Language": {
+ "type": "string",
+ "description": "Returns the value that was specified for the Content-Language request header."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Accept-Ranges": {
+ "type": "string",
+ "description": "Indicates that the service supports requests for partial file content."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-copy-completion-time": {
+ "x-ms-client-name": "CopyCompletionTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt."
+ },
+ "x-ms-copy-status-description": {
+ "x-ms-client-name": "CopyStatusDescription",
+ "type": "string",
+ "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure."
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for the last attempted Copy File operation where this file was the destination file."
+ },
+ "x-ms-copy-progress": {
+ "x-ms-client-name": "CopyProgress",
+ "type": "string",
+ "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied."
+ },
+ "x-ms-copy-source": {
+ "x-ms-client-name": "CopySource",
+ "type": "string",
+ "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by 'x-ms-copy-id'.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-content-md5": {
+ "x-ms-client-name": "FileContentMD5",
+ "type": "string",
+ "format": "byte",
+ "description": "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 whole 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."
+ },
+ "x-ms-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)."
+ },
+ "x-ms-file-attributes": {
+ "x-ms-client-name": "FileAttributes",
+ "type": "string",
+ "description": "Attributes set for the file."
+ },
+ "x-ms-file-creation-time": {
+ "x-ms-client-name": "FileCreationTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Creation time for the file."
+ },
+ "x-ms-file-last-write-time": {
+ "x-ms-client-name": "FileLastWriteTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last write time for the file."
+ },
+ "x-ms-file-change-time": {
+ "x-ms-client-name": "FileChangeTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Change time for the file."
+ },
+ "x-ms-file-permission-key": {
+ "x-ms-client-name": "FilePermissionKey",
+ "type": "string",
+ "description": "Key of the permission set for the file."
+ },
+ "x-ms-file-id": {
+ "x-ms-client-name": "FileId",
+ "type": "string",
+ "description": "The fileId of the file."
+ },
+ "x-ms-file-parent-id": {
+ "x-ms-client-name": "FileParentId",
+ "type": "string",
+ "description": "The parent fileId of the file."
+ }
+ },
+ "schema": {
+ "type": "object",
+ "format": "file"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "head": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_GetProperties",
+ "description": "Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.",
+ "parameters": [{
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time."
+ },
+ "x-ms-meta": {
+ "type": "string",
+ "description": "A set of name-value pairs associated with this file as user-defined metadata.",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "x-ms-type": {
+ "x-ms-client-name": "FileType",
+ "description": "Returns the type File. Reserved for future use.",
+ "type": "string",
+ "enum": [
+ "File"
+ ]
+ },
+ "Content-Length": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file."
+ },
+ "Content-Type": {
+ "type": "string",
+ "description": "The content type specified for the file. The default content type is 'application/octet-stream'"
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity."
+ },
+ "Content-Encoding": {
+ "type": "string",
+ "description": "If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header."
+ },
+ "Cache-Control": {
+ "type": "string",
+ "description": "If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header."
+ },
+ "Content-Disposition": {
+ "type": "string",
+ "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response."
+ },
+ "Content-Language": {
+ "type": "string",
+ "description": "Returns the value that was specified for the Content-Language request header."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-copy-completion-time": {
+ "x-ms-client-name": "CopyCompletionTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt."
+ },
+ "x-ms-copy-status-description": {
+ "x-ms-client-name": "CopyStatusDescription",
+ "type": "string",
+ "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure."
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for the last attempted Copy File operation where this file was the destination file."
+ },
+ "x-ms-copy-progress": {
+ "x-ms-client-name": "CopyProgress",
+ "type": "string",
+ "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied."
+ },
+ "x-ms-copy-source": {
+ "x-ms-client-name": "CopySource",
+ "type": "string",
+ "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by 'x-ms-copy-id'.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)."
+ },
+ "x-ms-file-attributes": {
+ "x-ms-client-name": "FileAttributes",
+ "type": "string",
+ "description": "Attributes set for the file."
+ },
+ "x-ms-file-creation-time": {
+ "x-ms-client-name": "FileCreationTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Creation time for the file."
+ },
+ "x-ms-file-last-write-time": {
+ "x-ms-client-name": "FileLastWriteTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last write time for the file."
+ },
+ "x-ms-file-change-time": {
+ "x-ms-client-name": "FileChangeTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Change time for the file."
+ },
+ "x-ms-file-permission-key": {
+ "x-ms-client-name": "FilePermissionKey",
+ "type": "string",
+ "description": "Key of the permission set for the file."
+ },
+ "x-ms-file-id": {
+ "x-ms-client-name": "FileId",
+ "type": "string",
+ "description": "The fileId of the file."
+ },
+ "x-ms-file-parent-id": {
+ "x-ms-client-name": "FileParentId",
+ "type": "string",
+ "description": "The parent fileId of the file."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_Delete",
+ "description": "removes the file from the storage account.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Success (Accepted).",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+
+ ]
+ },
+ "/{shareName}/{directory}/{fileName}?comp=properties": {
+ "put": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_SetHTTPHeaders",
+ "description": "Sets HTTP headers on the file.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "x-ms-content-length",
+ "x-ms-client-name": "fileContentLength",
+ "in": "header",
+ "description": "Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared.",
+ "required": false,
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "$ref": "#/parameters/FileContentType"
+ },
+ {
+ "$ref": "#/parameters/FileContentEncoding"
+ },
+ {
+ "$ref": "#/parameters/FileContentLanguage"
+ },
+ {
+ "$ref": "#/parameters/FileCacheControl"
+ },
+ {
+ "$ref": "#/parameters/FileContentMD5"
+ },
+ {
+ "$ref": "#/parameters/FileContentDisposition"
+ },
+ {
+ "$ref": "#/parameters/FilePermission"
+ },
+ {
+ "$ref": "#/parameters/FilePermissionKey"
+ },
+ {
+ "$ref": "#/parameters/FileAttributes"
+ },
+ {
+ "$ref": "#/parameters/FileCreationTime"
+ },
+ {
+ "$ref": "#/parameters/FileLastWriteTime"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the file, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ },
+ "x-ms-file-permission-key": {
+ "x-ms-client-name": "FilePermissionKey",
+ "type": "string",
+ "description": "Key of the permission set for the file."
+ },
+ "x-ms-file-attributes": {
+ "x-ms-client-name": "FileAttributes",
+ "type": "string",
+ "description": "Attributes set for the file."
+ },
+ "x-ms-file-creation-time": {
+ "x-ms-client-name": "FileCreationTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Creation time for the file."
+ },
+ "x-ms-file-last-write-time": {
+ "x-ms-client-name": "FileLastWriteTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last write time for the file."
+ },
+ "x-ms-file-change-time": {
+ "x-ms-client-name": "FileChangeTime",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Change time for the file."
+ },
+ "x-ms-file-id": {
+ "x-ms-client-name": "FileId",
+ "type": "string",
+ "description": "The fileId of the directory."
+ },
+ "x-ms-file-parent-id": {
+ "x-ms-client-name": "FileParentId",
+ "type": "string",
+ "description": "The parent fileId of the directory."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }]
+ },
+ "/{shareName}/{directory}/{fileName}?comp=metadata": {
+ "put": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_SetMetadata",
+ "description": "Updates user-defined metadata for the specified file.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success (OK).",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the file, in quotes."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "metadata"
+ ]
+ }]
+ },
+ "/{shareName}/{directory}/{fileName}?comp=range": {
+ "put": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_UploadRange",
+ "description": "Upload a range of bytes to a file.",
+ "consumes": [
+ "application/octet-stream"
+ ],
+ "parameters": [{
+ "$ref": "#/parameters/OptionalBody"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "name": "x-ms-range",
+ "x-ms-client-name": "range",
+ "in": "header",
+ "description": "Specifies the range of bytes to be written. Both the start and end of the range must be specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the range can be up to the value of the file's full size. The File service accepts only a single byte range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following format: bytes=startByte-endByte.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "x-ms-write",
+ "x-ms-client-name": "FileRangeWrite",
+ "in": "header",
+ "description": "Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and set the Range header to a value that indicates the range to clear, up to maximum file size.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "update",
+ "clear"
+ ],
+ "default": "update",
+ "x-ms-enum": {
+ "name": "FileRangeWriteType",
+ "modelAsString": false
+ }
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/ContentMD5"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success (Created).",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the file, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share."
+ },
+ "Content-MD5": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "range"
+ ]
+ }]
+ },
+ "/{shareName}/{directory}/{fileName}?comp=range&fromURL": {
+ "put": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_UploadRangeFromURL",
+ "description": "Upload a range of bytes to a file where the contents are read from a URL.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/TargetRange"
+ },
+ {
+ "$ref": "#/parameters/CopySource"
+ },
+ {
+ "$ref": "#/parameters/SourceRange"
+ },
+ {
+ "$ref": "#/parameters/FileRangeWriteFromUrl"
+ },
+ {
+ "$ref": "#/parameters/ContentLength"
+ },
+ {
+ "$ref": "#/parameters/SourceContentCrc64"
+ },
+ {
+ "$ref": "#/parameters/SourceIfMatchCrc64"
+ },
+ {
+ "$ref": "#/parameters/SourceIfNoneMatchCrc64"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success (Created).",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the file, in quotes."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share."
+ },
+ "x-ms-content-crc64": {
+ "type": "string",
+ "format": "byte",
+ "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-request-server-encrypted": {
+ "x-ms-client-name": "IsServerEncrypted",
+ "type": "boolean",
+ "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "range"
+ ]
+ }]
+ },
+ "/{shareName}/{directory}/{fileName}?comp=rangelist": {
+ "get": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_GetRangeList",
+ "description": "Returns the list of valid ranges for a file.",
+ "parameters": [{
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "x-ms-range",
+ "x-ms-client-name": "range",
+ "in": "header",
+ "description": "Specifies the range of bytes over which to list ranges, inclusively.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The date/time that the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the file's last modified time."
+ },
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "The ETag contains a value which represents the version of the file, in quotes."
+ },
+ "x-ms-content-length": {
+ "x-ms-client-name": "FileContentLength",
+ "type": "integer",
+ "format": "int64",
+ "description": "The size of the file in bytes."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/RangeList"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "rangelist"
+ ]
+ }]
+ },
+ "/{shareName}/{directory}/{fileName}?comp=copy": {
+ "put": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_StartCopy",
+ "description": "Copies a blob or file to a destination file within the storage account.",
+ "parameters": [{
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/CopySource"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The copy file has been accepted with the specified copy status.",
+ "headers": {
+ "ETag": {
+ "type": "string",
+ "format": "etag",
+ "description": "If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy."
+ },
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Returns the date/time that the copy operation to the destination file completed."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-copy-id": {
+ "x-ms-client-name": "CopyId",
+ "type": "string",
+ "description": "String identifier for this copy operation. Use with Get File or Get File Properties to check the status of this copy operation, or pass to Abort Copy File to abort a pending copy."
+ },
+ "x-ms-copy-status": {
+ "x-ms-client-name": "CopyStatus",
+ "description": "State of the copy operation identified by x-ms-copy-id.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "aborted",
+ "failed"
+ ],
+ "x-ms-enum": {
+ "name": "CopyStatusType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+
+ ]
+ },
+ "/{shareName}/{directory}/{fileName}?comp=copy©id={CopyId}": {
+ "put": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_AbortCopy",
+ "description": "Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata.",
+ "parameters": [{
+ "$ref": "#/parameters/CopyId"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/CopyActionAbort"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "The delete request was accepted and the file will be deleted.",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "copy"
+ ]
+ }]
+ },
+ "/{shareName}/{directory}/{fileName}?comp=listhandles": {
+ "get":{
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_ListHandles",
+ "description": "Lists handles for file",
+ "parameters":[
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/MaxResults"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "Content-Type": {
+ "type": "string",
+ "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/ListHandlesResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "listhandles"
+ ]
+ }
+ ]
+ },
+ "/{shareName}/{directory}/{fileName}?comp=forceclosehandles": {
+ "put": {
+ "tags": [
+ "file"
+ ],
+ "operationId": "File_ForceCloseHandles",
+ "description": "Closes all handles open for given file",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/ShareSnapshot"
+ },
+ {
+ "$ref": "#/parameters/HandleId"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the File service used to execute the request."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated."
+ },
+ "x-ms-marker": {
+ "x-ms-client-name": "marker",
+ "type": "string",
+ "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request."
+ },
+ "x-ms-number-of-handles-closed": {
+ "x-ms-client-name": "numberOfHandlesClosed",
+ "type": "integer",
+ "description": "Contains count of number of handles closed."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [{
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "forceclosehandles"
+ ]
+ }
+ ]
+ }
+ },
+ "definitions": {
+ "AccessPolicy": {
+ "description": "An Access policy.",
+ "type": "object",
+ "properties": {
+ "Start": {
+ "description": "The date-time the policy is active.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "Expiry": {
+ "description": "The date-time the policy expires.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "Permission": {
+ "description": "The permissions for the ACL policy.",
+ "type": "string"
+ }
+ }
+ },
+ "CorsRule": {
+ "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.",
+ "type": "object",
+ "required": [
+ "AllowedOrigins",
+ "AllowedMethods",
+ "AllowedHeaders",
+ "ExposedHeaders",
+ "MaxAgeInSeconds"
+ ],
+ "properties": {
+ "AllowedOrigins": {
+ "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.",
+ "type": "string"
+ },
+ "AllowedMethods": {
+ "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)",
+ "type": "string"
+ },
+ "AllowedHeaders": {
+ "description": "The request headers that the origin domain may specify on the CORS request.",
+ "type": "string"
+ },
+ "ExposedHeaders": {
+ "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.",
+ "type": "string"
+ },
+ "MaxAgeInSeconds": {
+ "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.",
+ "type": "integer",
+ "minimum": 0
+ }
+ }
+ },
+ "ErrorCode": {
+ "description": "Error codes returned by the service",
+ "type": "string",
+ "enum": [
+ "AccountAlreadyExists",
+ "AccountBeingCreated",
+ "AccountIsDisabled",
+ "AuthenticationFailed",
+ "AuthorizationFailure",
+ "ConditionHeadersNotSupported",
+ "ConditionNotMet",
+ "EmptyMetadataKey",
+ "InsufficientAccountPermissions",
+ "InternalError",
+ "InvalidAuthenticationInfo",
+ "InvalidHeaderValue",
+ "InvalidHttpVerb",
+ "InvalidInput",
+ "InvalidMd5",
+ "InvalidMetadata",
+ "InvalidQueryParameterValue",
+ "InvalidRange",
+ "InvalidResourceName",
+ "InvalidUri",
+ "InvalidXmlDocument",
+ "InvalidXmlNodeValue",
+ "Md5Mismatch",
+ "MetadataTooLarge",
+ "MissingContentLengthHeader",
+ "MissingRequiredQueryParameter",
+ "MissingRequiredHeader",
+ "MissingRequiredXmlNode",
+ "MultipleConditionHeadersNotSupported",
+ "OperationTimedOut",
+ "OutOfRangeInput",
+ "OutOfRangeQueryParameterValue",
+ "RequestBodyTooLarge",
+ "ResourceTypeMismatch",
+ "RequestUrlFailedToParse",
+ "ResourceAlreadyExists",
+ "ResourceNotFound",
+ "ServerBusy",
+ "UnsupportedHeader",
+ "UnsupportedXmlNode",
+ "UnsupportedQueryParameter",
+ "UnsupportedHttpVerb",
+ "CannotDeleteFileOrDirectory",
+ "ClientCacheFlushDelay",
+ "DeletePending",
+ "DirectoryNotEmpty",
+ "FileLockConflict",
+ "InvalidFileOrDirectoryPathName",
+ "ParentNotFound",
+ "ReadOnlyAttribute",
+ "ShareAlreadyExists",
+ "ShareBeingDeleted",
+ "ShareDisabled",
+ "ShareNotFound",
+ "SharingViolation",
+ "ShareSnapshotInProgress",
+ "ShareSnapshotCountExceeded",
+ "ShareSnapshotOperationNotSupported",
+ "ShareHasSnapshots",
+ "ContainerQuotaDowngradeNotAllowed"
+ ],
+ "x-ms-enum": {
+ "name": "StorageErrorCode",
+ "modelAsString": true
+ }
+ },
+ "FilesAndDirectoriesListSegment": {
+ "description": "Abstract for entries that can be listed from Directory.",
+ "type": "object",
+ "required": [
+ "DirectoryItems",
+ "FileItems"
+ ],
+ "properties": {
+ "DirectoryItems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DirectoryItem"
+ }
+ },
+ "FileItems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FileItem"
+ }
+ }
+ },
+ "xml": {
+ "name": "Entries"
+ }
+ },
+ "DirectoryItem": {
+ "xml": {
+ "name": "Directory"
+ },
+ "description": "A listed directory item.",
+ "type": "object",
+ "required": [
+ "Name"
+ ],
+ "properties": {
+ "Name": {
+ "type": "string"
+ }
+ }
+ },
+ "FileItem": {
+ "xml": {
+ "name": "File"
+ },
+ "description": "A listed file item.",
+ "type": "object",
+ "required": [
+ "Name",
+ "Properties"
+ ],
+ "properties": {
+ "Name": {
+ "type": "string"
+ },
+ "Properties": {
+ "$ref": "#/definitions/FileProperty"
+ }
+ }
+ },
+ "FileProperty": {
+ "description": "File properties.",
+ "type": "object",
+ "required": [
+ "Content-Length"
+ ],
+ "properties": {
+ "Content-Length": {
+ "description": "Content length of the file. This value may not be up-to-date since an SMB client may have modified the file locally. The value of Content-Length may not reflect that fact until the handle is closed or the op-lock is broken. To retrieve current property values, call Get File Properties.",
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "HandleItem" : {
+ "xml": {
+ "name": "Handle"
+ },
+ "description": "A listed Azure Storage handle item.",
+ "type": "object",
+ "required": [
+ "HandleId",
+ "Path",
+ "FileId",
+ "SessionId",
+ "ClientIp",
+ "OpenTime"
+ ],
+ "properties": {
+ "HandleId": {
+ "type": "string",
+ "description": "XSMB service handle ID"
+ },
+ "Path": {
+ "type": "string",
+ "description": "File or directory name including full path starting from share root"
+ },
+ "FileId": {
+ "type": "string",
+ "description": "FileId uniquely identifies the file or directory."
+ },
+ "ParentId": {
+ "type": "string",
+ "description": "ParentId uniquely identifies the parent directory of the object."
+ },
+ "SessionId": {
+ "type": "string",
+ "description": "SMB session ID in context of which the file handle was opened"
+ },
+ "ClientIp": {
+ "type": "string",
+ "description": "Client IP that opened the handle"
+ },
+ "OpenTime": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Time when the session that previously opened the handle has last been reconnected. (UTC)"
+ },
+ "LastReconnectTime": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Time handle was last connected to (UTC)"
+ }
+ }
+ },
+ "ListFilesAndDirectoriesSegmentResponse": {
+ "xml": {
+ "name": "EnumerationResults"
+ },
+ "description": "An enumeration of directories and files.",
+ "type": "object",
+ "required": [
+ "ServiceEndpoint",
+ "ShareName",
+ "DirectoryPath",
+ "Prefix",
+ "NextMarker",
+ "Segment"
+ ],
+ "properties": {
+ "ServiceEndpoint": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "ShareName": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "ShareSnapshot": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "DirectoryPath": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "Prefix": {
+ "type": "string"
+ },
+ "Marker": {
+ "type": "string"
+ },
+ "MaxResults": {
+ "type": "integer"
+ },
+ "Segment": {
+ "$ref": "#/definitions/FilesAndDirectoriesListSegment"
+ },
+ "NextMarker": {
+ "type": "string"
+ }
+ }
+ },
+ "ListHandlesResponse": {
+ "xml": {
+ "name": "EnumerationResults"
+ },
+ "description": "An enumeration of handles.",
+ "type": "object",
+ "required": [
+ "NextMarker"
+ ],
+ "properties": {
+ "HandleList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HandleItem"
+ },
+ "xml": {
+ "name": "Entries",
+ "wrapped": true
+ }
+ },
+ "NextMarker": {
+ "type": "string"
+ }
+ }
+ },
+ "ListSharesResponse": {
+ "xml": {
+ "name": "EnumerationResults"
+ },
+ "description": "An enumeration of shares.",
+ "type": "object",
+ "required": [
+ "ServiceEndpoint",
+ "NextMarker"
+ ],
+ "properties": {
+ "ServiceEndpoint": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "Prefix": {
+ "type": "string"
+ },
+ "Marker": {
+ "type": "string"
+ },
+ "MaxResults": {
+ "type": "integer"
+ },
+ "ShareItems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ShareItem"
+ },
+ "xml": {
+ "name": "Shares",
+ "wrapped": true
+ }
+ },
+ "NextMarker": {
+ "type": "string"
+ }
+ }
+ },
+ "Metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "Metrics": {
+ "description": "Storage Analytics metrics for file service.",
+ "required": [
+ "Version",
+ "Enabled"
+ ],
+ "properties": {
+ "Version": {
+ "description": "The version of Storage Analytics to configure.",
+ "type": "string"
+ },
+ "Enabled": {
+ "description": "Indicates whether metrics are enabled for the File service.",
+ "type": "boolean"
+ },
+ "IncludeAPIs": {
+ "description": "Indicates whether metrics should generate summary statistics for called API operations.",
+ "type": "boolean"
+ },
+ "RetentionPolicy": {
+ "$ref": "#/definitions/RetentionPolicy"
+ }
+ }
+ },
+ "Range": {
+ "description": "An Azure Storage file range.",
+ "type": "object",
+ "required": [
+ "Start",
+ "End"
+ ],
+ "properties": {
+ "Start": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Start of the range."
+ },
+ "End": {
+ "type": "integer",
+ "format": "int64",
+ "description": "End of the range."
+ }
+ },
+ "xml": {
+ "name": "Range"
+ }
+ },
+ "RangeList": {
+ "description": "A list of non-overlapping valid ranges, sorted by increasing address range.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Range"
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "Ranges"
+ }
+ },
+ "StorageError": {
+ "type": "object",
+ "properties": {
+ "Message": {
+ "type": "string"
+ }
+ }
+ },
+ "RetentionPolicy": {
+ "description": "The retention policy.",
+ "type": "object",
+ "required": [
+ "Enabled"
+ ],
+ "properties": {
+ "Enabled": {
+ "description": "Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it.",
+ "type": "boolean"
+ },
+ "Days": {
+ "description": "Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires.",
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 365
+ }
+ }
+ },
+ "ShareItem": {
+ "xml": {
+ "name": "Share"
+ },
+ "description": "A listed Azure Storage share item.",
+ "type": "object",
+ "required": [
+ "Name",
+ "Properties"
+ ],
+ "properties": {
+ "Name": {
+ "type": "string"
+ },
+ "Snapshot": {
+ "type": "string"
+ },
+ "Properties": {
+ "$ref": "#/definitions/ShareProperties"
+ },
+ "Metadata": {
+ "$ref": "#/definitions/Metadata"
+ }
+ }
+ },
+ "ShareProperties": {
+ "description": "Properties of a share.",
+ "type": "object",
+ "required": [
+ "Last-Modified",
+ "Etag",
+ "Quota"
+ ],
+ "properties": {
+ "Last-Modified": {
+ "type": "string",
+ "format": "date-time-rfc1123"
+ },
+ "Etag": {
+ "type": "string",
+ "format": "etag"
+ },
+ "Quota": {
+ "type": "integer"
+ },
+ "EnabledProtocols": {
+ "type": "string"
+ },
+ "RootSquash": {
+ "type": "string"
+ }
+ }
+ },
+ "ShareStats": {
+ "description": "Stats for the share.",
+ "type": "object",
+ "required": [
+ "ShareUsageBytes"
+ ],
+ "properties": {
+ "ShareUsageBytes": {
+ "description": "The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files.",
+ "type": "integer"
+ }
+ }
+ },
+ "SignedIdentifier": {
+ "description": "Signed identifier.",
+ "type": "object",
+ "required": [
+ "Id"
+ ],
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "A unique id."
+ },
+ "AccessPolicy": {
+ "description": "The access policy.",
+ "$ref": "#/definitions/AccessPolicy"
+ }
+ }
+ },
+ "SignedIdentifiers": {
+ "description": "A collection of signed identifiers.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SignedIdentifier",
+ "xml": {
+ "name": "SignedIdentifier"
+ }
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "SignedIdentifiers"
+ }
+ },
+ "StorageServiceProperties": {
+ "description": "Storage service properties.",
+ "type": "object",
+ "properties": {
+ "HourMetrics": {
+ "description": "A summary of request statistics grouped by API in hourly aggregates for files.",
+ "$ref": "#/definitions/Metrics"
+ },
+ "MinuteMetrics": {
+ "description": "A summary of request statistics grouped by API in minute aggregates for files.",
+ "$ref": "#/definitions/Metrics"
+ },
+ "Cors": {
+ "description": "The set of CORS rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CorsRule"
+ },
+ "xml": {
+ "wrapped": true
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ApiVersionParameter": {
+ "name": "x-ms-version",
+ "x-ms-client-name": "version",
+ "in": "header",
+ "description": "Specifies the version of the operation to use for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "ContentLength": {
+ "name": "Content-Length",
+ "x-ms-client-name": "contentLength",
+ "in": "header",
+ "description": "Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero.",
+ "required": true,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method"
+ },
+ "ContentMD5": {
+ "name": "Content-MD5",
+ "x-ms-client-name": "contentMD5",
+ "in": "header",
+ "description": "An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request).",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method"
+ },
+ "CopyActionAbort": {
+ "name": "x-ms-copy-action",
+ "x-ms-client-name": "copyActionAbortConstant",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "abort"
+ ],
+ "x-ms-parameter-location": "method"
+ },
+ "CopyId": {
+ "name": "copyid",
+ "x-ms-client-name": "copyId",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy File operation."
+ },
+ "CopySource": {
+ "name": "x-ms-copy-source",
+ "x-ms-client-name": "copySource",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source."
+ },
+ "DeleteSnapshots": {
+ "name": "x-ms-delete-snapshots",
+ "x-ms-client-name": "deleteSnapshots",
+ "description": "Specifies the option include to delete the base share and all of its snapshots.",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "include"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteSnapshotsOptionType",
+ "modelAsString": false
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "FileAttributes": {
+ "name": "x-ms-file-attributes",
+ "x-ms-client-name": "FileAttributes",
+ "in": "header",
+ "description": "If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "FileCacheControl": {
+ "name": "x-ms-cache-control",
+ "x-ms-client-name": "fileCacheControl",
+ "description": "Sets the file's cache control. The File service stores this value but does not use or modify it.",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "file-HTTP-headers"
+ }
+ },
+ "FileContentDisposition": {
+ "name": "x-ms-content-disposition",
+ "x-ms-client-name": "fileContentDisposition",
+ "description": "Sets the file's Content-Disposition header.",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "file-HTTP-headers"
+ }
+ },
+ "FileContentEncoding": {
+ "name": "x-ms-content-encoding",
+ "x-ms-client-name": "fileContentEncoding",
+ "in": "header",
+ "description": "Specifies which content encodings have been applied to the file.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "file-HTTP-headers"
+ }
+ },
+ "FileContentLanguage": {
+ "name": "x-ms-content-language",
+ "x-ms-client-name": "fileContentLanguage",
+ "in": "header",
+ "description": "Specifies the natural languages used by this resource.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "file-HTTP-headers"
+ }
+ },
+ "FileContentMD5": {
+ "name": "x-ms-content-md5",
+ "x-ms-client-name": "fileContentMD5",
+ "in": "header",
+ "description": "Sets the file's MD5 hash.",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "file-HTTP-headers"
+ }
+ },
+ "FileContentType": {
+ "name": "x-ms-content-type",
+ "x-ms-client-name": "fileContentType",
+ "in": "header",
+ "description": "Sets the MIME content type of the file. The default type is 'application/octet-stream'.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "file-HTTP-headers"
+ }
+ },
+ "FileCreationTime": {
+ "name": "x-ms-file-creation-time",
+ "x-ms-client-name": "FileCreationTime",
+ "in": "header",
+ "description": "Creation time for the file/directory. Default value: Now.",
+ "required": true,
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "x-ms-parameter-location": "method"
+ },
+ "FileLastWriteTime": {
+ "name": "x-ms-file-last-write-time",
+ "x-ms-client-name": "FileLastWriteTime",
+ "in": "header",
+ "description": "Last write time for the file/directory. Default value: Now.",
+ "required": true,
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "x-ms-parameter-location": "method"
+ },
+ "FilePermission": {
+ "name": "x-ms-file-permission",
+ "x-ms-client-name": "FilePermission",
+ "in": "header",
+ "description": "If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "FilePermissionKey": {
+ "name": "x-ms-file-permission-key",
+ "x-ms-client-name": "FilePermissionKey",
+ "in": "header",
+ "description": "Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "FileRangeWriteFromUrl": {
+ "name": "x-ms-write",
+ "x-ms-client-name": "fileRangeWriteFromUrl",
+ "in": "header",
+ "description": "Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "update"
+ ],
+ "default": "update",
+ "x-ms-enum": {
+ "name": "FileRangeWriteFromUrlType",
+ "modelAsString": false
+ }
+ },
+ "FileType": {
+ "name": "x-ms-type",
+ "x-ms-client-name": "fileTypeConstant",
+ "in": "header",
+ "required": true,
+ "description": "Dummy constant parameter, file type can only be file.",
+ "type": "string",
+ "enum": [
+ "file"
+ ],
+ "x-ms-parameter-location": "method"
+ },
+ "GetRangeContentMD5": {
+ "name": "x-ms-range-get-content-md5",
+ "x-ms-client-name": "rangeGetContentMD5",
+ "in": "header",
+ "required": false,
+ "type": "boolean",
+ "x-ms-parameter-location": "method",
+ "description": "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 4 MB in size."
+ },
+ "HandleId": {
+ "name": "x-ms-handle-id",
+ "x-ms-client-name": "handleId",
+ "in": "header",
+ "description": "Specifies handle ID opened on the file or directory to be closed. Asterix (‘*’) is a wildcard that specifies all handles.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "ListSharesInclude": {
+ "name": "include",
+ "in": "query",
+ "description": "Include this parameter to specify one or more datasets to include in the response.",
+ "required": false,
+ "type": "array",
+ "collectionFormat": "csv",
+ "items": {
+ "type": "string",
+ "enum": [
+ "snapshots",
+ "metadata"
+ ],
+ "x-ms-enum": {
+ "name": "ListSharesIncludeType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "Marker": {
+ "name": "marker",
+ "in": "query",
+ "description": "A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "MaxResults": {
+ "name": "maxresults",
+ "in": "query",
+ "description": "Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.",
+ "required": false,
+ "type": "integer",
+ "minimum": 1,
+ "x-ms-parameter-location": "method"
+ },
+ "Metadata": {
+ "name": "x-ms-meta",
+ "x-ms-client-name": "metadata",
+ "in": "header",
+ "description": "A name-value pair to associate with a file storage object.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "OptionalBody": {
+ "name": "optionalbody",
+ "in": "body",
+ "description": "Initial data.",
+ "required": false,
+ "schema": {
+ "type": "object",
+ "format": "file"
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "Prefix": {
+ "name": "prefix",
+ "in": "query",
+ "description": "Filters the results to return only entries whose name begins with the specified prefix.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "Range": {
+ "name": "x-ms-range",
+ "x-ms-client-name": "range",
+ "in": "header",
+ "description": "Return file data only from the specified byte range.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "Recursive": {
+ "name": "x-ms-recursive",
+ "x-ms-client-name": "recursive",
+ "in": "header",
+ "description": "Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.",
+ "required": false,
+ "type": "boolean",
+ "x-ms-parameter-location": "method"
+ },
+ "Url": {
+ "name": "url",
+ "in": "path",
+ "description": "The URL of the service account, share, directory or file that is the target of the desired operation.",
+ "required": true,
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ "ShareAcl": {
+ "name": "shareAcl",
+ "in": "body",
+ "description": "The ACL for the share.",
+ "schema": {
+ "$ref": "#/definitions/SignedIdentifiers"
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "EnabledProtocols": {
+ "name": "x-ms-enabled-protocols",
+ "x-ms-client-name": "enabledProtocols",
+ "in": "header",
+ "description": "Specifies the protocols enabled on the share.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "RootSquash": {
+ "name": "x-ms-root-squash",
+ "x-ms-client-name": "rootSquash",
+ "in": "header",
+ "description": "Specifies the user ID mapping option of the share.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "ShareQuota": {
+ "name": "x-ms-share-quota",
+ "x-ms-client-name": "quota",
+ "in": "header",
+ "description": "Specifies the maximum size of the share, in gigabytes.",
+ "required": false,
+ "type": "integer",
+ "minimum": 1,
+ "x-ms-parameter-location": "method"
+ },
+ "ShareSnapshot": {
+ "name": "sharesnapshot",
+ "in": "query",
+ "description": "The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "SourceContentCrc64": {
+ "name": "x-ms-source-content-crc64",
+ "x-ms-client-name": "sourceContentCrc64",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method",
+ "description": "Specify the crc64 calculated for the range of bytes that must be read from the copy source."
+ },
+ "SourceIfMatchCrc64": {
+ "name": "x-ms-source-if-match-crc64",
+ "x-ms-client-name": "sourceIfMatchCrc64",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "source-modified-access-conditions"
+ },
+ "description": "Specify the crc64 value to operate only on range with a matching crc64 checksum."
+ },
+ "SourceIfNoneMatchCrc64": {
+ "name": "x-ms-source-if-none-match-crc64",
+ "x-ms-client-name": "sourceIfNoneMatchCrc64",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "format": "byte",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "name": "source-modified-access-conditions"
+ },
+ "description": "Specify the crc64 value to operate only on range without a matching crc64 checksum."
+ },
+ "SourceRange": {
+ "name": "x-ms-source-range",
+ "x-ms-client-name": "sourceRange",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Bytes of source data in the specified range."
+ },
+ "StorageServiceProperties": {
+ "name": "StorageServiceProperties",
+ "in": "body",
+ "description": "The StorageService properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageServiceProperties"
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "TargetRange": {
+ "name": "x-ms-range",
+ "x-ms-client-name": "Range",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Writes data to the specified byte range in the file."
+ },
+ "Timeout": {
+ "name": "timeout",
+ "in": "query",
+ "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
+ "required": false,
+ "type": "integer",
+ "minimum": 0,
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
\ No newline at end of file
diff --git a/samples/Storage.Files/readme.md b/samples/Storage.Files/readme.md
new file mode 100644
index 00000000..88647310
--- /dev/null
+++ b/samples/Storage.Files/readme.md
@@ -0,0 +1,11 @@
+# Storage
+### AutoRest Configuration
+> see https://aka.ms/autorest
+
+``` yaml
+title: Storage.Files
+require:
+- $(this-folder)/../readme.samples.md
+- https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Files.Shares/swagger/readme.md
+namespace: Azure.Storage.Files
+```
\ No newline at end of file
diff --git a/samples/Storage.Queues/queue.json b/samples/Storage.Queues/queue.json
new file mode 100644
index 00000000..5a0375d7
--- /dev/null
+++ b/samples/Storage.Queues/queue.json
@@ -0,0 +1,1941 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Azure Queue Storage",
+ "version": "2019-02-02",
+ "x-ms-code-generation-settings": {
+ "header": "MIT",
+ "strictSpecAdherence": false
+ }
+ },
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{url}",
+ "useSchemePrefix": false,
+ "positionInOperation": "first",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Url"
+ }
+ ]
+ },
+ "securityDefinitions": {
+ "queue_shared_key": {
+ "type": "apiKey",
+ "name": "Authorization",
+ "in": "header"
+ }
+ },
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/xml"
+ ],
+ "produces": [
+ "application/xml"
+ ],
+ "paths": {},
+ "x-ms-paths": {
+ "/?restype=service&comp=properties": {
+ "put": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_SetProperties",
+ "description": "Sets properties for a storage account's Queue service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules",
+ "parameters": [
+ {
+ "$ref": "#/parameters/StorageServiceProperties"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Success (Accepted)",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_GetProperties",
+ "description": "gets the properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageServiceProperties"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "service"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "properties"
+ ]
+ }
+ ]
+ },
+ "/?restype=service&comp=stats": {
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_GetStatistics",
+ "description": "Retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageServiceStats"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "restype",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "service"
+ ]
+ },
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "stats"
+ ]
+ }
+ ]
+ },
+ "/?comp=list": {
+ "get": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Service_ListQueuesSegment",
+ "description": "The List Queues Segment operation returns a list of the queues under the specified account",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Prefix"
+ },
+ {
+ "$ref": "#/parameters/Marker"
+ },
+ {
+ "$ref": "#/parameters/MaxResults"
+ },
+ {
+ "$ref": "#/parameters/ListQueuesInclude"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/ListQueuesSegmentResponse"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "NextMarker"
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "list"
+ ]
+ }
+ ]
+ },
+ "/{queueName}": {
+ "put": {
+ "tags": [
+ "service"
+ ],
+ "operationId": "Queue_Create",
+ "description": "creates a new queue under the given account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success, queue created.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "204": {
+ "description": "Success, queue created.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "queue"
+ ],
+ "operationId": "Queue_Delete",
+ "description": "operation permanently deletes the specified queue",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": []
+ },
+ "/{queueName}?comp=metadata": {
+ "get": {
+ "tags": [
+ "queue"
+ ],
+ "operationId": "Queue_GetProperties",
+ "description": "Retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated with the queue as name-values pairs.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success.",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-meta": {
+ "type": "string",
+ "x-ms-client-name": "Metadata",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "x-ms-approximate-messages-count": {
+ "type": "integer",
+ "x-ms-client-name": "ApproximateMessagesCount",
+ "description": "The approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "queue"
+ ],
+ "operationId": "Queue_SetMetadata",
+ "description": "sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/Metadata"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "metadata"
+ ]
+ }
+ ]
+ },
+ "/{queueName}?comp=acl": {
+ "get": {
+ "tags": [
+ "queue"
+ ],
+ "operationId": "Queue_GetAccessPolicy",
+ "description": "returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/SignedIdentifiers"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "queue"
+ ],
+ "operationId": "Queue_SetAccessPolicy",
+ "description": "sets stored access policies for the queue that may be used with Shared Access Signatures",
+ "parameters": [
+ {
+ "$ref": "#/parameters/QueueAcl"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "comp",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "acl"
+ ]
+ }
+ ]
+ },
+ "/{queueName}/messages": {
+ "get": {
+ "tags": [
+ "message"
+ ],
+ "operationId": "Messages_Dequeue",
+ "description": "The Dequeue operation retrieves one or more messages from the front of the queue.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/NumOfMessages"
+ },
+ {
+ "$ref": "#/parameters/VisibilityTimeout"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/DequeuedMessagesList"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "message"
+ ],
+ "operationId": "Messages_Clear",
+ "description": "The Clear operation deletes all messages from the specified queue.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": []
+ },
+ "/{queueName}/messages?visibilitytimeout={visibilityTimeout}&messagettl={messageTimeToLive}": {
+ "post": {
+ "tags": [
+ "message"
+ ],
+ "operationId": "Messages_Enqueue",
+ "description": "The Enqueue operation adds a new message to the back of the message queue. A visibility timeout can also be specified to make the message invisible until the visibility timeout expires. A message must be in a format that can be included in an XML request with UTF-8 encoding. The encoded message can be up to 64 KB in size for versions 2011-08-18 and newer, or 8 KB in size for previous versions.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/QueueMessage"
+ },
+ {
+ "$ref": "#/parameters/VisibilityTimeout"
+ },
+ {
+ "$ref": "#/parameters/MessageTTL"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/EnqueuedMessageList"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": []
+ },
+ "/{queueName}/messages?peekonly=true": {
+ "get": {
+ "tags": [
+ "message"
+ ],
+ "operationId": "Messages_Peek",
+ "description": "The Peek operation retrieves one or more messages from the front of the queue, but does not alter the visibility of the message.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/NumOfMessages"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/PeekedMessagesList"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "peekonly",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "true"
+ ]
+ }
+ ]
+ },
+ "/{queueName}/messages/{messageid}?popreceipt={popReceipt}&visibilitytimeout={visibilityTimeout}": {
+ "put": {
+ "tags": [
+ "messageId"
+ ],
+ "operationId": "MessageId_Update",
+ "description": "The Update operation was introduced with version 2011-08-18 of the Queue service API. The Update Message operation updates the visibility timeout of a message. You can also use this operation to update the contents of a message. A message must be in a format that can be included in an XML request with UTF-8 encoding, and the encoded message can be up to 64KB in size.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/QueueMessage"
+ },
+ {
+ "$ref": "#/parameters/PopReceipt"
+ },
+ {
+ "$ref": "#/parameters/VisibilityTimeoutRequired"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ },
+ "x-ms-popreceipt": {
+ "x-ms-client-name": "PopReceipt",
+ "type": "string",
+ "description": "The pop receipt of the queue message."
+ },
+ "x-ms-time-next-visible": {
+ "x-ms-client-name": "TimeNextVisible",
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "A UTC date/time value that represents when the message will be visible on the queue."
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": []
+ },
+ "/{queueName}/messages/{messageid}?popreceipt={popReceipt}": {
+ "delete": {
+ "tags": [
+ "messageId"
+ ],
+ "operationId": "MessageId_Delete",
+ "description": "The Delete operation deletes the specified message.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/PopReceipt"
+ },
+ {
+ "$ref": "#/parameters/Timeout"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "headers": {
+ "x-ms-client-request-id": {
+ "x-ms-client-name": "ClientRequestId",
+ "type": "string",
+ "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+ },
+ "x-ms-request-id": {
+ "x-ms-client-name": "RequestId",
+ "type": "string",
+ "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+ },
+ "x-ms-version": {
+ "x-ms-client-name": "Version",
+ "type": "string",
+ "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+ },
+ "Date": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+ }
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "headers": {
+ "x-ms-error-code": {
+ "x-ms-client-name": "ErrorCode",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/StorageError"
+ }
+ }
+ }
+ },
+ "parameters": []
+ }
+ },
+ "definitions": {
+ "AccessPolicy": {
+ "type": "object",
+ "required": [
+ "Start",
+ "Expiry",
+ "Permission"
+ ],
+ "description": "An Access policy",
+ "properties": {
+ "Start": {
+ "description": "the date-time the policy is active",
+ "type": "string",
+ "format": "date-time"
+ },
+ "Expiry": {
+ "description": "the date-time the policy expires",
+ "type": "string",
+ "format": "date-time"
+ },
+ "Permission": {
+ "description": "the permissions for the acl policy",
+ "type": "string"
+ }
+ }
+ },
+ "ListQueuesSegmentResponse": {
+ "xml": {
+ "name": "EnumerationResults"
+ },
+ "description": "The object returned when calling List Queues on a Queue Service.",
+ "type": "object",
+ "required": [
+ "ServiceEndpoint",
+ "Prefix",
+ "MaxResults",
+ "NextMarker"
+ ],
+ "properties": {
+ "ServiceEndpoint": {
+ "type": "string",
+ "xml": {
+ "attribute": true
+ }
+ },
+ "Prefix": {
+ "type": "string"
+ },
+ "Marker": {
+ "type": "string"
+ },
+ "MaxResults": {
+ "type": "integer"
+ },
+ "QueueItems": {
+ "xml": {
+ "wrapped": true,
+ "name": "Queues"
+ },
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/QueueItem"
+ }
+ },
+ "NextMarker": {
+ "type": "string"
+ }
+ }
+ },
+ "CorsRule": {
+ "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain",
+ "type": "object",
+ "required": [
+ "AllowedOrigins",
+ "AllowedMethods",
+ "AllowedHeaders",
+ "ExposedHeaders",
+ "MaxAgeInSeconds"
+ ],
+ "properties": {
+ "AllowedOrigins": {
+ "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.",
+ "type": "string"
+ },
+ "AllowedMethods": {
+ "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)",
+ "type": "string"
+ },
+ "AllowedHeaders": {
+ "description": "the request headers that the origin domain may specify on the CORS request.",
+ "type": "string"
+ },
+ "ExposedHeaders": {
+ "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer",
+ "type": "string"
+ },
+ "MaxAgeInSeconds": {
+ "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.",
+ "type": "integer",
+ "minimum": 0
+ }
+ }
+ },
+ "ErrorCode": {
+ "description": "Error codes returned by the service",
+ "type": "string",
+ "enum": [
+ "AccountAlreadyExists",
+ "AccountBeingCreated",
+ "AccountIsDisabled",
+ "AuthenticationFailed",
+ "AuthorizationFailure",
+ "ConditionHeadersNotSupported",
+ "ConditionNotMet",
+ "EmptyMetadataKey",
+ "InsufficientAccountPermissions",
+ "InternalError",
+ "InvalidAuthenticationInfo",
+ "InvalidHeaderValue",
+ "InvalidHttpVerb",
+ "InvalidInput",
+ "InvalidMd5",
+ "InvalidMetadata",
+ "InvalidQueryParameterValue",
+ "InvalidRange",
+ "InvalidResourceName",
+ "InvalidUri",
+ "InvalidXmlDocument",
+ "InvalidXmlNodeValue",
+ "Md5Mismatch",
+ "MetadataTooLarge",
+ "MissingContentLengthHeader",
+ "MissingRequiredQueryParameter",
+ "MissingRequiredHeader",
+ "MissingRequiredXmlNode",
+ "MultipleConditionHeadersNotSupported",
+ "OperationTimedOut",
+ "OutOfRangeInput",
+ "OutOfRangeQueryParameterValue",
+ "RequestBodyTooLarge",
+ "ResourceTypeMismatch",
+ "RequestUrlFailedToParse",
+ "ResourceAlreadyExists",
+ "ResourceNotFound",
+ "ServerBusy",
+ "UnsupportedHeader",
+ "UnsupportedXmlNode",
+ "UnsupportedQueryParameter",
+ "UnsupportedHttpVerb",
+ "InvalidMarker",
+ "MessageNotFound",
+ "MessageTooLarge",
+ "PopReceiptMismatch",
+ "QueueAlreadyExists",
+ "QueueBeingDeleted",
+ "QueueDisabled",
+ "QueueNotEmpty",
+ "QueueNotFound"
+ ],
+ "x-ms-enum": {
+ "name": "StorageErrorCode",
+ "modelAsString": true
+ }
+ },
+ "GeoReplication": {
+ "type": "object",
+ "required": [
+ "Status",
+ "LastSyncTime"
+ ],
+ "properties": {
+ "Status": {
+ "description": "The status of the secondary location",
+ "type": "string",
+ "enum": [
+ "live",
+ "bootstrap",
+ "unavailable"
+ ],
+ "x-ms-enum": {
+ "name": "GeoReplicationStatusType",
+ "modelAsString": true
+ }
+ },
+ "LastSyncTime": {
+ "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ }
+ },
+ "Logging": {
+ "description": "Azure Analytics Logging settings.",
+ "type": "object",
+ "required": [
+ "Version",
+ "Delete",
+ "Read",
+ "Write",
+ "RetentionPolicy"
+ ],
+ "properties": {
+ "Version": {
+ "description": "The version of Storage Analytics to configure.",
+ "type": "string"
+ },
+ "Delete": {
+ "description": "Indicates whether all delete requests should be logged.",
+ "type": "boolean"
+ },
+ "Read": {
+ "description": "Indicates whether all read requests should be logged.",
+ "type": "boolean"
+ },
+ "Write": {
+ "description": "Indicates whether all write requests should be logged.",
+ "type": "boolean"
+ },
+ "RetentionPolicy": {
+ "$ref": "#/definitions/RetentionPolicy"
+ }
+ }
+ },
+ "Metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "StorageError": {
+ "type": "object",
+ "properties": {
+ "Message": {
+ "type": "string"
+ }
+ }
+ },
+ "Metrics": {
+ "description": "",
+ "required": [
+ "Enabled"
+ ],
+ "properties": {
+ "Version": {
+ "description": "The version of Storage Analytics to configure.",
+ "type": "string"
+ },
+ "Enabled": {
+ "description": "Indicates whether metrics are enabled for the Queue service.",
+ "type": "boolean"
+ },
+ "IncludeAPIs": {
+ "description": "Indicates whether metrics should generate summary statistics for called API operations.",
+ "type": "boolean"
+ },
+ "RetentionPolicy": {
+ "$ref": "#/definitions/RetentionPolicy"
+ }
+ }
+ },
+ "QueueItem": {
+ "description": "An Azure Storage Queue.",
+ "type": "object",
+ "required": [
+ "Name"
+ ],
+ "properties": {
+ "Name": {
+ "type": "string",
+ "description": "The name of the Queue."
+ },
+ "Metadata": {
+ "$ref": "#/definitions/Metadata"
+ }
+ },
+ "xml": {
+ "name": "Queue"
+ }
+ },
+ "QueueMessage": {
+ "description": "A Message object which can be stored in a Queue",
+ "type": "object",
+ "required": [
+ "MessageText"
+ ],
+ "properties": {
+ "MessageText": {
+ "type": "string",
+ "description": "The content of the message"
+ }
+ }
+ },
+ "DequeuedMessageItem": {
+ "description": "The object returned in the QueueMessageList array when calling Get Messages on a Queue.",
+ "type": "object",
+ "required": [
+ "MessageId",
+ "InsertionTime",
+ "ExpirationTime",
+ "PopReceipt",
+ "TimeNextVisible",
+ "DequeueCount",
+ "MessageText"
+ ],
+ "properties": {
+ "MessageId": {
+ "type": "string",
+ "description": "The Id of the Message."
+ },
+ "InsertionTime": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The time the Message was inserted into the Queue."
+ },
+ "ExpirationTime": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The time that the Message will expire and be automatically deleted."
+ },
+ "PopReceipt": {
+ "type": "string",
+ "description": "This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client."
+ },
+ "TimeNextVisible": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The time that the message will again become visible in the Queue."
+ },
+ "DequeueCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of times the message has been dequeued."
+ },
+ "MessageText": {
+ "type": "string",
+ "description": "The content of the Message."
+ }
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "QueueMessage"
+ }
+ },
+ "PeekedMessageItem": {
+ "description": "The object returned in the QueueMessageList array when calling Peek Messages on a Queue",
+ "type": "object",
+ "required": [
+ "MessageId",
+ "InsertionTime",
+ "ExpirationTime",
+ "DequeueCount",
+ "MessageText"
+ ],
+ "properties": {
+ "MessageId": {
+ "type": "string",
+ "description": "The Id of the Message."
+ },
+ "InsertionTime": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The time the Message was inserted into the Queue."
+ },
+ "ExpirationTime": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The time that the Message will expire and be automatically deleted."
+ },
+ "DequeueCount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number of times the message has been dequeued."
+ },
+ "MessageText": {
+ "type": "string",
+ "description": "The content of the Message."
+ }
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "QueueMessage"
+ }
+ },
+ "EnqueuedMessage": {
+ "description": "The object returned in the QueueMessageList array when calling Put Message on a Queue",
+ "type": "object",
+ "required": [
+ "MessageId",
+ "InsertionTime",
+ "ExpirationTime",
+ "PopReceipt",
+ "TimeNextVisible"
+ ],
+ "properties": {
+ "MessageId": {
+ "type": "string",
+ "description": "The Id of the Message."
+ },
+ "InsertionTime": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The time the Message was inserted into the Queue."
+ },
+ "ExpirationTime": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The time that the Message will expire and be automatically deleted."
+ },
+ "PopReceipt": {
+ "type": "string",
+ "description": "This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client."
+ },
+ "TimeNextVisible": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "The time that the message will again become visible in the Queue."
+ }
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "QueueMessage"
+ }
+ },
+ "DequeuedMessagesList": {
+ "description": "The object returned when calling Get Messages on a Queue",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DequeuedMessageItem",
+ "xml": {
+ "name": "QueueMessage"
+ }
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "QueueMessagesList"
+ }
+ },
+ "PeekedMessagesList": {
+ "description": "The object returned when calling Peek Messages on a Queue",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PeekedMessageItem",
+ "xml": {
+ "name": "QueueMessage"
+ }
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "QueueMessagesList"
+ }
+ },
+ "EnqueuedMessageList": {
+ "description": "The object returned when calling Put Message on a Queue",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EnqueuedMessage",
+ "xml": {
+ "name": "QueueMessage"
+ }
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "QueueMessagesList"
+ }
+ },
+ "RetentionPolicy": {
+ "description": "the retention policy",
+ "type": "object",
+ "required": [
+ "Enabled"
+ ],
+ "properties": {
+ "Enabled": {
+ "description": "Indicates whether a retention policy is enabled for the storage service",
+ "type": "boolean"
+ },
+ "Days": {
+ "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted",
+ "type": "integer",
+ "minimum": 1
+ }
+ }
+ },
+ "SignedIdentifier": {
+ "description": "signed identifier",
+ "type": "object",
+ "required": [
+ "Id",
+ "AccessPolicy"
+ ],
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "a unique id"
+ },
+ "AccessPolicy": {
+ "description": "The access policy",
+ "$ref": "#/definitions/AccessPolicy"
+ }
+ }
+ },
+ "SignedIdentifiers": {
+ "description": "a collection of signed identifiers",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SignedIdentifier",
+ "xml": {
+ "name": "SignedIdentifier"
+ }
+ },
+ "xml": {
+ "wrapped": true,
+ "name": "SignedIdentifiers"
+ }
+ },
+ "StorageServiceProperties": {
+ "description": "Storage Service Properties.",
+ "type": "object",
+ "properties": {
+ "Logging": {
+ "description": "Azure Analytics Logging settings",
+ "$ref": "#/definitions/Logging"
+ },
+ "HourMetrics": {
+ "description": "A summary of request statistics grouped by API in hourly aggregates for queues",
+ "$ref": "#/definitions/Metrics"
+ },
+ "MinuteMetrics": {
+ "description": "a summary of request statistics grouped by API in minute aggregates for queues",
+ "$ref": "#/definitions/Metrics"
+ },
+ "Cors": {
+ "description": "The set of CORS rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CorsRule",
+ "xml": {
+ "name": "CorsRule"
+ }
+ },
+ "xml": {
+ "wrapped": true
+ }
+ }
+ }
+ },
+ "StorageServiceStats": {
+ "description": "Stats for the storage service.",
+ "type": "object",
+ "properties": {
+ "GeoReplication": {
+ "description": "Geo-Replication information for the Secondary Storage Service",
+ "$ref": "#/definitions/GeoReplication"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "Url": {
+ "name": "url",
+ "description": "The URL of the service account, queue or message that is the targe of the desired operation.",
+ "required": true,
+ "type": "string",
+ "in": "path",
+ "x-ms-skip-url-encoding": true
+ },
+ "ApiVersionParameter": {
+ "name": "x-ms-version",
+ "x-ms-client-name": "version",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "description": "Specifies the version of the operation to use for this request.",
+ "enum": [
+ "2019-02-02"
+ ]
+ },
+ "Body": {
+ "name": "body",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "format": "file"
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Initial data"
+ },
+ "QueueAcl": {
+ "name": "queueAcl",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/SignedIdentifiers"
+ },
+ "x-ms-parameter-location": "method",
+ "description": "the acls for the queue"
+ },
+ "ClientRequestId": {
+ "name": "x-ms-client-request-id",
+ "x-ms-client-name": "requestId",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled."
+ },
+ "ContentLength": {
+ "name": "Content-Length",
+ "in": "header",
+ "required": true,
+ "type": "integer",
+ "format": "int64",
+ "x-ms-parameter-location": "method",
+ "description": "The length of the request."
+ },
+ "ListQueuesInclude": {
+ "name": "include",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "collectionFormat": "csv",
+ "items": {
+ "type": "string",
+ "enum": [
+ "metadata"
+ ],
+ "x-ms-enum": {
+ "name": "ListQueuesIncludeType",
+ "modelAsString": false
+ }
+ },
+ "x-ms-parameter-location": "method",
+ "description": "Include this parameter to specify that the queues's metadata be returned as part of the response body."
+ },
+ "Marker": {
+ "name": "marker",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "A string value that identifies the portion of the list of queues to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all queues remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.",
+ "x-ms-parameter-location": "method"
+ },
+ "MaxResults": {
+ "name": "maxresults",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "minimum": 1,
+ "x-ms-parameter-location": "method",
+ "description": "Specifies the maximum number of queues to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000."
+ },
+ "MessageId": {
+ "name": "messageid",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The container name."
+ },
+ "MessageTTL": {
+ "name": "messagettl",
+ "x-ms-client-name": "MessageTimeToLive",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "minimum": -1,
+ "x-ms-parameter-location": "method",
+ "description": "Optional. Specifies the time-to-live interval for the message, in seconds. Prior to version 2017-07-29, the maximum time-to-live allowed is 7 days. For version 2017-07-29 or later, the maximum time-to-live can be any positive number, as well as -1 indicating that the message does not expire. If this parameter is omitted, the default time-to-live is 7 days."
+ },
+ "Metadata": {
+ "name": "x-ms-meta",
+ "x-ms-client-name": "metadata",
+ "in": "header",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. Note that metadata requested with this parameter must be stored in accordance with the naming restrictions imposed by the 2009-09-19 version of the Queue service. Beginning with this version, all metadata names must adhere to the naming conventions for C# identifiers.",
+ "x-ms-header-collection-prefix": "x-ms-meta-"
+ },
+ "NumOfMessages": {
+ "name": "numofmessages",
+ "x-ms-client-name": "numberOfMessages",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "minimum": 1,
+ "x-ms-parameter-location": "method",
+ "description": "Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation."
+ },
+ "PopReceipt": {
+ "name": "popreceipt",
+ "x-ms-client-name": "popReceipt",
+ "in": "query",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "description": "Required. Specifies the valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation.",
+ "type": "string"
+ },
+ "Prefix": {
+ "name": "prefix",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Filters the results to return only queues whose name begins with the specified prefix.",
+ "x-ms-parameter-location": "method"
+ },
+ "QueueMessage": {
+ "name": "QueueMessage",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/QueueMessage"
+ },
+ "x-ms-parameter-location": "method",
+ "description": "A Message object which can be stored in a Queue"
+ },
+ "QueueName": {
+ "name": "queueName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "description": "The queue name."
+ },
+ "StorageServiceProperties": {
+ "name": "StorageServiceProperties",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageServiceProperties"
+ },
+ "x-ms-parameter-location": "method",
+ "description": "The StorageService properties."
+ },
+ "Timeout": {
+ "name": "timeout",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "minimum": 0,
+ "x-ms-parameter-location": "method",
+ "description": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
+ },
+ "VisibilityTimeout": {
+ "name": "visibilitytimeout",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 604800,
+ "x-ms-parameter-location": "method",
+ "description": "Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time."
+ },
+ "VisibilityTimeoutRequired": {
+ "name": "visibilitytimeout",
+ "in": "query",
+ "required": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 604800,
+ "x-ms-parameter-location": "method",
+ "description": "Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time."
+ }
+ }
+}
\ No newline at end of file
diff --git a/samples/Storage.Queues/readme.md b/samples/Storage.Queues/readme.md
new file mode 100644
index 00000000..c899b35c
--- /dev/null
+++ b/samples/Storage.Queues/readme.md
@@ -0,0 +1,11 @@
+# Storage
+### AutoRest Configuration
+> see https://aka.ms/autorest
+
+``` yaml
+title: Storage.Queues
+require:
+- $(this-folder)/../readme.samples.md
+- https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Queues/swagger/readme.md
+namespace: Azure.Storage.Queues
+```
\ No newline at end of file
diff --git a/samples/Storage/readme.md b/samples/Storage/readme.md
deleted file mode 100644
index b4418929..00000000
--- a/samples/Storage/readme.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# Storage
-### AutoRest Configuration
-> see https://aka.ms/autorest
-
-``` yaml
-title: Storage
-require: $(this-folder)/../readme.samples.md
-input-file: DataLakeStorage.json
-namespace: Microsoft.Azure.Storage
-```
\ No newline at end of file
diff --git a/src/AutoRest.CSharp.V3/CodeGen/WriterBase.cs b/src/AutoRest.CSharp.V3/CodeGen/WriterBase.cs
index a446f4bc..f45be2c3 100644
--- a/src/AutoRest.CSharp.V3/CodeGen/WriterBase.cs
+++ b/src/AutoRest.CSharp.V3/CodeGen/WriterBase.cs
@@ -128,9 +128,6 @@ namespace AutoRest.CSharp.V3.CodeGen
.Select(ns => $"using {ns};")
.ToArray();
var usingBlock = usingLines.Any() ? String.Join(Environment.NewLine, usingLines) + Environment.NewLine + Environment.NewLine : String.Empty;
- //var usingBlock = String.Join(Environment.NewLine, usingLines);
- //var removeLine = usingBlock.Any() ? String.Empty : Environment.NewLine;
- //var extraLine = usingBlock.Any() ? Environment.NewLine : String.Empty;
Replace(usingBlockIdentifier + Environment.NewLine, usingBlock);
});
}