-
Notifications
You must be signed in to change notification settings - Fork 5.5k
[SRP] 2021-06-01 Swagger Api #15627
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[SRP] 2021-06-01 Swagger Api #15627
Changes from 1 commit
7e0f275
bcc34d8
cd00304
0e97cb8
8f56578
6de3994
f1badd9
b4148fa
847c109
25376ca
fc726c4
7adc973
e9c931c
c2d7d76
e45d622
9ea84fe
b0b8143
c9e2ce7
b5d8fa3
6755cb0
445fc20
68fb003
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -325,6 +325,9 @@ | |
"x-ms-examples": { | ||
"GetContainers": { | ||
"$ref": "./examples/BlobContainersGet.json" | ||
}, | ||
"GetBlobContainersGetWithAllowProtectedAppendWritesAll": { | ||
"$ref": "./examples/BlobContainersGetWithAllowProtectedAppendWritesAll.json" | ||
} | ||
}, | ||
"description": "Gets properties of a specified container. ", | ||
|
@@ -401,6 +404,9 @@ | |
"x-ms-examples": { | ||
"SetLegalHoldContainers": { | ||
"$ref": "./examples/BlobContainersSetLegalHold.json" | ||
}, | ||
"SetLegalHoldContainersWithAllowProtectedAppendWritesAll": { | ||
"$ref": "./examples/BlobContainersSetLegalHoldAllowProtectedAppendWritesAll.json" | ||
} | ||
}, | ||
"description": "Sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request.", | ||
|
@@ -497,6 +503,9 @@ | |
"x-ms-examples": { | ||
"CreateOrUpdateImmutabilityPolicy": { | ||
"$ref": "./examples/BlobContainersPutImmutabilityPolicy.json" | ||
}, | ||
"CreateOrUpdateImmutabilityPolicyWithAllowProtectedAppendWritesAll": { | ||
"$ref": "./examples/BlobContainersPutImmutabilityPolicyAllowProtectedAppendWritesAll.json" | ||
} | ||
}, | ||
"description": "Creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation.", | ||
|
@@ -1042,7 +1051,11 @@ | |
}, | ||
"allowProtectedAppendWrites": { | ||
"type": "boolean", | ||
"description": "This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API" | ||
"description": "This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API." | ||
}, | ||
"allowProtectedAppendWritesAll": { | ||
"type": "boolean", | ||
"description": "This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Appened and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive." | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. (Optional ) We should change the Not sure if ARM team will have concern for this change as it's breaking, but if not change, the API parameter name looks not right. If not change, the generated SDK will has the parameter name for input immutabilityPolicy as "parameters", which doesn't make sense. The .net SDK API with current swagger (See "ImmutabilityPolicy parameters = default(ImmutabilityPolicy) ")
The .net SDK API after change
|
||
} | ||
}, | ||
"description": "The properties of an ImmutabilityPolicy of a blob container." | ||
|
@@ -1157,6 +1170,14 @@ | |
"type": "string", | ||
"readOnly": true, | ||
"description": "Returns the User Principal Name of the user who updated the ImmutabilityPolicy." | ||
}, | ||
"allowProtectedAppendWrites": { | ||
"type": "boolean", | ||
"description": "This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API." | ||
}, | ||
"allowProtectedAppendWritesAll": { | ||
"type": "boolean", | ||
"description": "This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Appened and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive." | ||
} | ||
}, | ||
"description": "An update history of the ImmutabilityPolicy of a blob container." | ||
|
@@ -1174,6 +1195,11 @@ | |
"$ref": "#/definitions/TagProperty" | ||
}, | ||
"description": "The list of LegalHold tags of a blob container." | ||
}, | ||
"protectedAppendWritesHistory": { | ||
"type": "object", | ||
"$ref": "#/definitions/ProtectedAppendWritesHistory", | ||
"description": "Protected append blob writes history." | ||
} | ||
}, | ||
"description": "The LegalHold property of a blob container." | ||
|
@@ -1209,6 +1235,21 @@ | |
}, | ||
"description": "A tag of the LegalHold of a blob container." | ||
}, | ||
"ProtectedAppendWritesHistory": { | ||
"properties": { | ||
"allowProtectedAppendWritesAll": { | ||
"type": "boolean", | ||
"description": "When enabled, new blocks can be written to both 'Appened and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted." | ||
}, | ||
"timestamp": { | ||
"type": "string", | ||
"format": "date-time", | ||
"readOnly": true, | ||
"description": "Returns the date and time the tag was added." | ||
} | ||
}, | ||
"description": "Protected append writes history setting for the blob container with Legal holds." | ||
}, | ||
"LegalHold": { | ||
"properties": { | ||
"hasLegalHold": { | ||
|
@@ -1224,6 +1265,10 @@ | |
"minLength": 3 | ||
}, | ||
"description": "Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP." | ||
}, | ||
"allowProtectedAppendWritesAll": { | ||
"type": "boolean", | ||
"description": "When enabled, new blocks can be written to both 'Appened and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted." | ||
} | ||
}, | ||
"required": [ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
{ | ||
"parameters": { | ||
"subscriptionId": "{subscription-id}", | ||
"resourceGroupName": "res9871", | ||
"accountName": "sto6217", | ||
"containerName": "container1634", | ||
"api-version": "2021-06-01", | ||
"monitor": "true" | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/blobServices/default/containers/container1634", | ||
"name": "container1634", | ||
"type": "Microsoft.Storage/storageAccounts/blobServices/containers", | ||
"etag": "\"0x8D592D74CC20EBA\"", | ||
"properties": { | ||
"publicAccess": "None", | ||
"leaseStatus": "Unlocked", | ||
"leaseState": "Available", | ||
"lastModifiedTime": "2018-03-26T05:06:14Z", | ||
"immutabilityPolicy": { | ||
"etag": "\"8d592d74cb3011a\"", | ||
"properties": { | ||
"immutabilityPeriodSinceCreationInDays": 100, | ||
"allowProtectedAppendWritesAll": true, | ||
"state": "Locked" | ||
}, | ||
"updateHistory": [ | ||
{ | ||
"update": "put", | ||
"immutabilityPeriodSinceCreationInDays": 3, | ||
"allowProtectedAppendWritesAll": true, | ||
"timestamp": "2018-03-26T05:06:11.431403Z", | ||
"objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", | ||
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" | ||
}, | ||
{ | ||
"update": "lock", | ||
"immutabilityPeriodSinceCreationInDays": 3, | ||
"allowProtectedAppendWritesAll": true, | ||
"timestamp": "2018-03-26T05:06:13.0907641Z", | ||
"objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", | ||
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" | ||
}, | ||
{ | ||
"update": "extend", | ||
"immutabilityPeriodSinceCreationInDays": 100, | ||
"allowProtectedAppendWritesAll": true, | ||
"timestamp": "2018-03-26T05:06:14.7097716Z", | ||
"objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", | ||
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" | ||
} | ||
] | ||
}, | ||
"legalHold": { | ||
"hasLegalHold": true, | ||
"protectedAppendWritesHistory": { | ||
"allowProtectedAppendWritesAll": true, | ||
"timestamp": "2021-09-01T01:58:44.5044483Z" | ||
}, | ||
"tags": [ | ||
{ | ||
"tag": "tag1", | ||
"timestamp": "2018-03-26T05:06:09.6964643Z", | ||
"objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", | ||
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" | ||
}, | ||
{ | ||
"tag": "tag2", | ||
"timestamp": "2018-03-26T05:06:09.6964643Z", | ||
"objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", | ||
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" | ||
}, | ||
{ | ||
"tag": "tag3", | ||
"timestamp": "2018-03-26T05:06:09.6964643Z", | ||
"objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", | ||
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" | ||
} | ||
] | ||
}, | ||
"hasImmutabilityPolicy": true, | ||
"hasLegalHold": true | ||
} | ||
} | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{ | ||
"parameters": { | ||
"subscriptionId": "{subscription-id}", | ||
"resourceGroupName": "res1782", | ||
"accountName": "sto7069", | ||
"containerName": "container6397", | ||
"immutabilityPolicyName": "default", | ||
"api-version": "2021-06-01", | ||
"monitor": "true", | ||
"parameters": { | ||
"properties": { | ||
"immutabilityPeriodSinceCreationInDays": 3, | ||
"allowProtectedAppendWritesAll": true | ||
} | ||
} | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"id": "/subscriptions/{subscription-id}/resourceGroups/res1782/providers/Microsoft.Storage/storageAccounts/sto7069/blobServices/default/containers/container6397/immutabilityPolicies/default", | ||
"name": "default", | ||
"type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", | ||
"etag": "\"8d59f830cb130e5\"", | ||
"properties": { | ||
"immutabilityPeriodSinceCreationInDays": 3, | ||
"allowProtectedAppendWritesAll": true, | ||
"state": "Unlocked" | ||
} | ||
} | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{ | ||
"parameters": { | ||
"subscriptionId": "{subscription-id}", | ||
"resourceGroupName": "res4303", | ||
"accountName": "sto7280", | ||
"containerName": "container8723", | ||
"api-version": "2021-06-01", | ||
"monitor": "true", | ||
"LegalHold": { | ||
"tags": [ | ||
"tag1", | ||
"tag2", | ||
"tag3" | ||
], | ||
"allowProtectedAppendWritesAll": true | ||
} | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"hasLegalHold": true, | ||
"tags": [ | ||
"tag1", | ||
"tag2", | ||
"tag3" | ||
], | ||
"allowProtectedAppendWritesAll": true | ||
} | ||
} | ||
} | ||
} |
Uh oh!
There was an error while loading. Please reload this page.