Added Set Expiry to Data Lake (#9620)

Azure · May 28, 2020 · 5304f17 · 5304f17
1 parent 460eedb
commit 5304f17
Showing 1 changed file with 116 additions and 2 deletions.
diff --git a/...ation/storage/data-plane/Microsoft.StorageDataLake/stable/2019-12-12/DataLakeStorage.json b/...ation/storage/data-plane/Microsoft.StorageDataLake/stable/2019-12-12/DataLakeStorage.json
@@ -2020,6 +2020,92 @@
           ]
         }
       ]
+    },
+    "/{filesystem}/{path}?comp=expiry": {
+      "put": {
+        "tags": [
+          "blob"
+        ],
+        "operationId": "Path_SetExpiry",
+        "description": "Sets the time a blob will expire and be deleted.",
+        "parameters": [
+          {
+            "$ref": "#/parameters/Timeout"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "#/parameters/ClientRequestId"
+          },
+          {
+            "$ref": "#/parameters/PathExpiryOptions"
+          },
+          {
+            "$ref": "#/parameters/PathExpiryTime"
+          }
+        ],
+        "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"
+          ]
+        }
+      ]
     }
   },
   "parameters": {
@@ -2031,7 +2117,7 @@
       "in": "path",
       "x-ms-skip-url-encoding": true
     },
-	"FileSystemResource": {
+    "FileSystemResource": {
 	  "name": "resource",
 	  "in": "query",
 	  "description": "The value must be \"filesystem\" for all filesystem operations.",
@@ -2526,7 +2612,35 @@
       "type": "integer",
       "format": "int64",
       "x-ms-parameter-location": "method"
-     }
+     },
+     "PathExpiryOptions": {
+      "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": "PathExpiryOptions",
+        "modelAsString": true
+      },
+      "x-ms-parameter-location": "method",
+      "description": "Required. Indicates mode of the expiry time"
+    },
+    "PathExpiryTime": {
+      "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"
+    }
   },
   "definitions": {
     "AclFailedEntry": {