Get Sas Definitions - Get Sas Definitions

Service:: Key Vault

API Version:: 7.4

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

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

With optional parameters:

GET {vaultBaseUrl}/storage/{storage-account-name}/sas?maxresults={maxresults}&api-version=7.4

URI Parameters

Name	In	Required	Type	Description
storage-account-name	path	True	string pattern: ^[0-9a-zA-Z]+$	The name of the storage account.
vaultBaseUrl	path	True	string	The vault name, for example `https://myvault.vault.azure.net`.
api-version	query	True	string	Client API version.
maxresults	query		integer (int32) minimum: 1 maximum: 25	Maximum number of results to return in a page. If not specified the service will return up to 25 results.

Responses

Name	Type	Description
200 OK	SasDefinitionListResult	A response message containing a list of SAS definitions along with a link to the next page of SAS definitions.
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

List Storage Sas Definition

Sample request

HTTP

GET https://myvault.vault.azure.net//storage/listsas01/sas?api-version=7.4

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "https://myvault.vault.azure.net/storage/listsas01/sas/listStrgSasDef01",
      "sid": "https://myvault.vault.azure.net/secrets/listsas01-listStrgSasDef01",
      "attributes": {
        "enabled": true,
        "created": 1490738438,
        "updated": 1490738438,
        "recoveryLevel": "Recoverable"
      }
    },
    {
      "id": "https://myvault.vault.azure.net/storage/listsas01/sas/listStrgSasDef02",
      "sid": "https://myvault.vault.azure.net/secrets/listsas01-listStrgSasDef02",
      "attributes": {
        "enabled": true,
        "created": 1490738438,
        "updated": 1490738438,
        "recoveryLevel": "Recoverable"
      }
    }
  ],
  "nextLink": "https://{BaseUri}/storage/listsas01/sas?api-version=7.2&%24skiptoken=<token>"
}

Definitions

Name	Description
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.
SasDefinitionItem	The SAS definition item containing storage SAS definition metadata.
SasDefinitionListResult	The storage account SAS definition list result.

DeletionRecoveryLevel

Enumeration

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.

Value	Description
Purgeable	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+Purgeable	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
Recoverable	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	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
CustomizedRecoverable+Purgeable	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.
CustomizedRecoverable	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	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.

Error

Object

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

Object

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.

SasDefinitionAttributes

Object

The SAS definition management attributes.

Name	Type	Description
created	integer (unixtime)	Creation time in UTC.
enabled	boolean	the enabled state of the object.
recoverableDays	integer (int32)	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 (unixtime)	Last updated time in UTC.

SasDefinitionItem

Object

The SAS definition item containing storage SAS definition metadata.

Name	Type	Description
attributes	SasDefinitionAttributes	The SAS definition management attributes.
id	string	The storage SAS identifier.
sid	string	The storage account SAS definition secret id.
tags	object	Application specific metadata in the form of key-value pairs.

SasDefinitionListResult

Object

The storage account SAS definition list result.

Name	Type	Description
nextLink	string	The URL to get the next set of SAS definitions.
value	SasDefinitionItem[]	A response message containing a list of SAS definitions along with a link to the next page of SAS definitions.

Share via

Get Sas Definitions - Get Sas Definitions

URI Parameters

Responses

Examples

List Storage Sas Definition

Sample request

Sample response

Definitions

DeletionRecoveryLevel

Error

KeyVaultError

SasDefinitionAttributes

SasDefinitionItem

SasDefinitionListResult