Added Share Soft Delete (#9015)

Azure · Apr 12, 2020 · 57d3ee7 · 57d3ee7
1 parent 58ebe4c
commit 57d3ee7
Showing 1 changed file with 128 additions and 2 deletions.
diff --git a/specification/storage/data-plane/Microsoft.FileStorage/preview/2019-12-12/file.json b/specification/storage/data-plane/Microsoft.FileStorage/preview/2019-12-12/file.json
@@ -1056,6 +1056,100 @@
                 }
             ]
         },
+        "/{shareName}?restype=share&comp=undelete": {
+            "put": {
+               "tags": [
+                    "share"
+                ],
+                "operationId": "Share_Restore",
+                "description": "Restores a previously deleted Share.",
+                "parameters": [
+                    {
+                        "$ref": "#/parameters/Timeout"
+                    },
+                    {
+                        "$ref": "#/parameters/ApiVersionParameter"
+                    },
+                    {
+                        "$ref": "#/parameters/ClientRequestId"
+                    },
+                    {
+                        "$ref": "#/parameters/DeletedShareName"
+                    },
+                    {
+                        "$ref": "#/parameters/DeletedShareVersion"
+                    }
+                ],
+                "responses": {
+                    "201": {
+                        "description": "Created",
+                        "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-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-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": [
+                        "undelete"
+                    ]
+                }
+            ]
+        },
         "/{shareName}/{directory}?restype=directory": {
             "put": {
                 "tags": [
@@ -4530,6 +4624,12 @@
                 "Snapshot": {
                     "type": "string"
                 },
+                "Deleted": {
+                    "type": "boolean"
+                },
+                "Version": {
+                    "type": "string"
+                },
                 "Properties": {
                     "$ref": "#/definitions/ShareProperties"
                 },
@@ -4570,6 +4670,13 @@
                 "NextAllowedQuotaDowngradeTime": {
                     "type": "string",
                     "format": "date-time-rfc1123"
+                },
+                "DeletedTime": {
+                    "type": "string",
+                    "format": "date-time-rfc1123"
+                },
+                "RemainingRetentionDays": {
+                    "type": "integer"
                 }
             }
         },
@@ -4801,7 +4908,25 @@
                 "name": "copy-file-smb-info"
             },
             "description": "Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state."
-        },  
+        },
+        "DeletedShareName": {
+            "name": "x-ms-deleted-share-name",
+            "x-ms-client-name": "DeletedShareName",
+            "description": "Specifies the name of the preivously-deleted share.",
+            "in": "header",
+            "required": false,
+            "type": "string",
+            "x-ms-parameter-location": "method"
+        },
+        "DeletedShareVersion": {
+            "name": "x-ms-deleted-share-version",
+            "x-ms-client-name": "DeletedShareVersion",
+            "description": "Specifies the version of the preivously-deleted share.",
+            "in": "header",
+            "required": false,
+            "type": "string",
+            "x-ms-parameter-location": "method"
+        },
         "DeleteSnapshots": {
             "name": "x-ms-delete-snapshots",
             "x-ms-client-name": "deleteSnapshots",
@@ -5034,7 +5159,8 @@
                 "type": "string",
                 "enum": [
                     "snapshots",
-                    "metadata"
+                    "metadata",
+                    "deleted"
                 ],
                 "x-ms-enum": {
                     "name": "ListSharesIncludeType",