Feature/storage/set expiry (#9079)

Azure · Apr 15, 2020 · 9f63721 · 9f63721
1 parent ee25e0f
commit 9f63721
Showing 1 changed file with 125 additions and 0 deletions.
diff --git a/specification/storage/data-plane/Microsoft.BlobStorage/preview/2019-12-12/blob.json b/specification/storage/data-plane/Microsoft.BlobStorage/preview/2019-12-12/blob.json
@@ -3711,6 +3711,12 @@
                 "format": "int64",
                 "description": "The number of tags associated with the blob"
               },
+              "x-ms-expiry-time": {
+                "x-ms-client-name": "ExpiresOn",
+                "type": "string",
+                "format": "date-time-rfc1123",
+                "description": "The time this blob will expire."
+              },
               "x-ms-blob-sealed": {
                 "x-ms-client-name": "IsSealed",
                 "type": "boolean",
@@ -4790,6 +4796,92 @@
         }
       ]
     },
+    "/{containerName}/{blob}?comp=expiry": {
+      "put": {
+        "tags": [
+          "blob"
+        ],
+        "operationId": "Blob_SetExpiry",
+        "description": "Sets the time a blob will expire and be deleted.",
+        "parameters": [
+          {
+            "$ref": "#/parameters/Timeout"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "#/parameters/ClientRequestId"
+          },
+          {
+            "$ref": "#/parameters/BlobExpiryOptions"
+          },
+          {
+            "$ref": "#/parameters/BlobExpiryTime"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The blob expiry 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."
+              }
+            }
+          },
+          "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": [
+            "expiry"
+          ]
+        }
+      ]
+    },
     "/{containerName}/{blob}?comp=properties&SetHTTPHeaders": {
       "put": {
         "tags": [
@@ -9419,6 +9511,11 @@
           "type": "string",
           "format": "date-time-rfc1123"
         },
+        "Expiry-Time": {
+          "x-ms-client-name": "ExpiresOn",
+          "type": "string",
+          "format": "date-time-rfc1123"
+        },
         "IsSealed": {
           "type": "boolean"
         }
@@ -10785,6 +10882,34 @@
       },
       "description": "Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request."
     },
+    "BlobExpiryOptions": {
+      "name": "x-ms-expiry-option",
+      "x-ms-client-name": "ExpiryOptions",
+      "in": "header",
+      "required": true,
+      "type": "string",
+      "enum": [
+        "NeverExpire",
+        "RelativeToCreation",
+        "RelativeToNow",
+        "Absolute"
+      ],
+      "x-ms-enum": {
+        "name": "BlobExpiryOptions",
+        "modelAsString": true
+      },
+      "x-ms-parameter-location": "method",
+      "description": "Required. Indicates mode of the expiry time"
+    },
+    "BlobExpiryTime": {
+      "name": "x-ms-expiry-time",
+      "x-ms-client-name": "ExpiresOn",
+      "in": "header",
+      "required": false,
+      "type": "string",
+      "x-ms-parameter-location": "method",
+      "description": "The time to set the blob to expiry"
+    },
     "BlobSequenceNumber": {
       "name": "x-ms-blob-sequence-number",
       "x-ms-client-name": "blobSequenceNumber",