[SRP] Expose lease container in Apr19 API. (#5733)

* [SRP] Expose lease container in Apr19 API. * Fix lease container example files; fix casing in Lease Container URL
Azure · Apr 29, 2019 · 27e6adc · 27e6adc
1 parent da72486
commit 27e6adc
Show file tree

Hide file tree

Showing 9 changed files with 184 additions and 80 deletions.
diff --git a/...er/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Acquire.json b/...er/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Acquire.json
@@ -7,24 +7,17 @@
     "api-version": "2018-03-01-preview",
     "monitor": "true",
     "parameters": {
-      "properties": {
-        "Action": 0,
-        "LeaseId": null,
-        "BreakPeriod": null,
-        "LeaseDuration": -1,
-        "ProposedLeaseId": null
-      }
+      "action": "Acquire",
+      "leaseId": null,
+      "breakPeriod": null,
+      "leaseDuration": -1,
+      "proposedLeaseId": null
     }
   },
   "responses": {
     "200": {
       "body": {
-        "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185",
-        "name": "container6185",
-        "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
-        "properties": {
-          "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d"
-        }
+        "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d"
       }
     }
   }

diff --git a/...ager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Break.json b/...ager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLease_Break.json
@@ -7,24 +7,17 @@
     "api-version": "2018-03-01-preview",
     "monitor": "true",
     "parameters": {
-      "properties": {
-        "Action": 4,
-        "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d",
-        "BreakPeriod": null,
-        "LeaseDuration": null,
-        "ProposedLeaseId": null
-      }
+      "action": "Break",
+      "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d",
+      "breakPeriod": null,
+      "leaseDuration": null,
+      "proposedLeaseId": null
     }
   },
   "responses": {
     "200": {
       "body": {
-        "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185",
-        "name": "container6185",
-        "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
-        "properties": {
-          "LeaseTimeSeconds": "0"
-        }
+        "leaseTimeSeconds": "0"
       }
     }
   }

diff --git a/...rce-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Acquire.json b/...rce-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Acquire.json
@@ -7,24 +7,17 @@
     "api-version": "2018-07-01",
     "monitor": "true",
     "parameters": {
-      "properties": {
-        "Action": 0,
-        "LeaseId": null,
-        "BreakPeriod": null,
-        "LeaseDuration": -1,
-        "ProposedLeaseId": null
-      }
+      "action": "Acquire",
+      "leaseId": null,
+      "breakPeriod": null,
+      "leaseDuration": -1,
+      "proposedLeaseId": null
     }
   },
   "responses": {
     "200": {
       "body": {
-        "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185",
-        "name": "container6185",
-        "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
-        "properties": {
-          "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d"
-        }
+        "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d"
       }
     }
   }

diff --git a/...ource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Break.json b/...ource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobContainersLease_Break.json
@@ -4,27 +4,20 @@
     "resourceGroupName": "res3376",
     "accountName": "sto328",
     "containerName": "container6185",
-    "api-version": "2018-03-01-preview",
+    "api-version": "2018-07-01",
     "monitor": "true",
     "parameters": {
-      "properties": {
-        "Action": 4,
-        "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d",
-        "BreakPeriod": null,
-        "LeaseDuration": null,
-        "ProposedLeaseId": null
-      }
+      "action": "Break",
+      "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d",
+      "breakPeriod": null,
+      "leaseDuration": null,
+      "proposedLeaseId": null
     }
   },
   "responses": {
     "200": {
       "body": {
-        "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185",
-        "name": "container6185",
-        "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
-        "properties": {
-          "LeaseTimeSeconds": "0"
-        }
+        "leaseTimeSeconds": "0"
       }
     }
   }

diff --git a/...rce-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Acquire.json b/...rce-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Acquire.json
@@ -7,24 +7,17 @@
     "api-version": "2018-11-01",
     "monitor": "true",
     "parameters": {
-      "properties": {
-        "Action": 0,
-        "LeaseId": null,
-        "BreakPeriod": null,
-        "LeaseDuration": -1,
-        "ProposedLeaseId": null
-      }
+      "action": "Acquire",
+      "leaseId": null,
+      "breakPeriod": null,
+      "leaseDuration": -1,
+      "proposedLeaseId": null
     }
   },
   "responses": {
     "200": {
       "body": {
-        "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185",
-        "name": "container6185",
-        "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
-        "properties": {
-          "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d"
-        }
+        "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d"
       }
     }
   }

diff --git a/...ource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Break.json b/...ource-manager/Microsoft.Storage/stable/2018-11-01/examples/BlobContainersLease_Break.json
@@ -4,27 +4,20 @@
     "resourceGroupName": "res3376",
     "accountName": "sto328",
     "containerName": "container6185",
-    "api-version": "2018-03-01-preview",
+    "api-version": "2018-11-01",
     "monitor": "true",
     "parameters": {
-      "properties": {
-        "Action": 4,
-        "LeaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d",
-        "BreakPeriod": null,
-        "LeaseDuration": null,
-        "ProposedLeaseId": null
-      }
+      "action": "Break",
+      "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d",
+      "breakPeriod": null,
+      "leaseDuration": null,
+      "proposedLeaseId": null
     }
   },
   "responses": {
     "200": {
       "body": {
-        "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185",
-        "name": "container6185",
-        "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
-        "properties": {
-          "LeaseTimeSeconds": "0"
-        }
+        "leaseTimeSeconds": "0"
       }
     }
   }

diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/blob.json
@@ -688,6 +688,56 @@
             }
           }
         }
+      },
+      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/lease": {
+        "post": {
+          "tags": [
+            "BlobContainers"
+          ],
+          "operationId": "BlobContainers_Lease",
+          "x-ms-examples": {
+            "Acquire a lease on a container": {
+              "$ref": "./examples/BlobContainersLease_Acquire.json"
+            },
+            "Break a lease on a container": {
+              "$ref": "./examples/BlobContainersLease_Break.json"
+            }
+          },
+          "description": "The Lease Container operation 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": "./storage.json#/parameters/ResourceGroupName"
+            },
+            {
+              "$ref": "./storage.json#/parameters/StorageAccountName"
+            },
+            {
+              "$ref": "#/parameters/ContainerName"
+            },
+            {
+              "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+            },
+            {
+              "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+            },
+            {
+              "name": "parameters",
+              "in": "body",
+              "schema": {
+                "$ref": "#/definitions/LeaseContainerRequest"
+              },
+              "description": "Lease Container request body."
+            }
+          ],
+          "responses": {
+            "200": {
+              "description": "OK -- Lease Container operation completed successfully.",
+              "schema": {
+                "$ref": "#/definitions/LeaseContainerResponse"
+              }
+            }
+          }
+        }
       }
     },
     "definitions": {
@@ -1114,6 +1164,54 @@
           "allowedHeaders"
         ],
         "description": "Specifies a CORS rule for the Blob service."
+      },
+      "LeaseContainerRequest": {
+        "properties": {
+          "action": {
+            "type": "string",
+            "enum": [
+              "Acquire",
+              "Renew",
+              "Change",
+              "Release",
+              "Break"
+            ],
+            "description": "Specifies the lease action. Can be one of the available actions."
+          },
+          "leaseId": {
+            "type": "string",
+            "description": "Identifies the lease. Can be specified in any valid GUID string format."
+          },
+          "breakPeriod": {
+            "type": "integer",
+            "description": "Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60."
+          },
+          "leaseDuration": {
+            "type": "integer",
+            "description": "Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires."
+          },
+          "proposedLeaseId": {
+            "type": "string",
+            "description": "Optional for acquire, required for change. Proposed lease ID, in a GUID string format."
+          }
+        },
+        "required": [
+          "action"
+        ],
+        "description": "Lease Container request schema."
+      },
+      "LeaseContainerResponse": {
+        "properties": {
+          "leaseId": {
+            "type": "string",
+            "description": "Returned unique lease ID that must be included with any request to delete the container, or to renew, change, or release the lease."
+          },
+          "leaseTimeSeconds": {
+            "type": "string",
+            "description": "Approximate time remaining in the lease period, in seconds."
+          }
+        },
+        "description": "Lease Container response schema."
       }
     },
     "parameters": {

diff --git a/...rce-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Acquire.json b/...rce-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Acquire.json
@@ -0,0 +1,24 @@
+{
+  "parameters": {
+    "subscriptionId": "{subscription-id}",
+    "resourceGroupName": "res3376",
+    "accountName": "sto328",
+    "containerName": "container6185",
+    "api-version": "2019-04-01",
+    "monitor": "true",
+    "parameters": {
+      "action": "Acquire",
+      "leaseId": null,
+      "breakPeriod": null,
+      "leaseDuration": -1,
+      "proposedLeaseId": null
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d"
+      }
+    }
+  }
+}
diff --git a/...ource-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Break.json b/...ource-manager/Microsoft.Storage/stable/2019-04-01/examples/BlobContainersLease_Break.json
@@ -0,0 +1,24 @@
+{
+  "parameters": {
+    "subscriptionId": "{subscription-id}",
+    "resourceGroupName": "res3376",
+    "accountName": "sto328",
+    "containerName": "container6185",
+    "api-version": "2019-04-01",
+    "monitor": "true",
+    "parameters": {
+      "action": "Break",
+      "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d",
+      "breakPeriod": null,
+      "leaseDuration": null,
+      "proposedLeaseId": null
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "leaseTimeSeconds": "0"
+      }
+    }
+  }
+}