Delete Sas Definition - Delete Sas Definition

Reference

Service:: Key Vault

API Version:: 7.4

Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.

DELETE {vaultBaseUrl}/storage/{storage-account-name}/sas/{sas-definition-name}?api-version=7.4

URI Parameters

Name	In	Required	Type	Description
sas-definition-name	path	True	string	The name of the SAS definition. Regex pattern: `^[0-9a-zA-Z]+$`
storage-account-name	path	True	string	The name of the storage account. Regex pattern: `^[0-9a-zA-Z]+$`
vaultBaseUrl	path	True	string	The vault name, for example https://myvault.vault.azure.net.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	DeletedSasDefinitionBundle	The deleted SAS definition and information on when the SAS definition will be deleted, and how to recover the deleted SAS definition.
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

Delete Storage Sas Definition

Sample Request

HTTP

DELETE https://myvault.vault.azure.net//storage/deletesas01/sas/deleteStrgSasDef01?api-version=7.4

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/storage/deletesas01/sas/deleteStrgSasDef01",
  "sid": "https://myvault.vault.azure.net/secrets/deletesas01-deleteStrgSasDef01",
  "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D",
  "sasType": "service",
  "validityPeriod": "P15D",
  "recoveryId": "https://myvault.vault.azure.net/deletedstorage/deletesas01/sas/deleteStrgSasDef01",
  "scheduledPurgeDate": 1490790000,
  "deletedDate": 1490760000,
  "attributes": {
    "enabled": true,
    "created": 1490738438,
    "updated": 1490738438,
    "recoveryLevel": "Recoverable"
  }
}

Definitions

Name	Description
DeletedSasDefinitionBundle	A deleted SAS definition bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged.
DeletionRecoveryLevel	Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval.
Error	The key vault server error.
KeyVaultError	The key vault error exception.
SasDefinitionAttributes	The SAS definition management attributes.
SasTokenType	The type of SAS token the SAS definition will create.

DeletedSasDefinitionBundle

A deleted SAS definition bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged.

Name	Type	Description
attributes	SasDefinitionAttributes	The SAS definition attributes.
deletedDate	integer	The time when the SAS definition was deleted, in UTC
id	string	The SAS definition id.
recoveryId	string	The url of the recovery object, used to identify and recover the deleted SAS definition.
sasType	SasTokenType	The type of SAS token the SAS definition will create.
scheduledPurgeDate	integer	The time when the SAS definition is scheduled to be purged, in UTC
sid	string	Storage account SAS definition secret id.
tags	object	Application specific metadata in the form of key-value pairs
templateUri	string	The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template.
validityPeriod	string	The validity period of SAS tokens created according to the SAS definition.

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval.

Name	Type	Description
CustomizedRecoverable	string	Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available.
CustomizedRecoverable+ProtectedSubscription	string	Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled.
CustomizedRecoverable+Purgeable	string	Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled.
Purgeable	string	Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)
Recoverable	string	Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered
Recoverable+ProtectedSubscription	string	Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered
Recoverable+Purgeable	string	Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered

Error

The key vault server error.

Name	Type	Description
code	string	The error code.
innererror	Error	The key vault server error.
message	string	The error message.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.

SasDefinitionAttributes

The SAS definition management attributes.

Name	Type	Description
created	integer	Creation time in UTC.
enabled	boolean	the enabled state of the object.
recoverableDays	integer	softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.
recoveryLevel	DeletionRecoveryLevel	Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the system can purge the SAS definition, at the end of the retention interval.
updated	integer	Last updated time in UTC.

SasTokenType

The type of SAS token the SAS definition will create.

Name	Type	Description
account	string
service	string