Get Sas Definition - Get Sas Definition

參考

Service:: Key Vault

API Version:: 7.4

取得指定記憶體帳戶之 SAS 定義的相關信息。此作業需要記憶體/取得許可權。

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

URI 參數

名稱	位於	必要	類型	Description
sas-definition-name	path	True	string	SAS 定義的名稱。 Regex pattern: `^[0-9a-zA-Z]+$`
storage-account-name	path	True	string	儲存體帳戶的名稱。 Regex pattern: `^[0-9a-zA-Z]+$`
vaultBaseUrl	path	True	string	儲存庫名稱，例如 https://myvault.vault.azure.net。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	SasDefinitionBundle	擷取的SAS定義。
Other Status Codes	KeyVaultError	金鑰保存庫錯誤回應，描述作業失敗的原因。

範例

Get Storage Sas Definition

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

定義

名稱	Description
DeletionRecoveryLevel	反映目前對目前保存庫中記憶體帳戶生效的刪除復原層級。如果它包含「可清除」，則具特殊許可權的使用者可以永久刪除記憶體帳戶;否則，只有系統可以在保留間隔結束時清除記憶體帳戶。
Error	金鑰儲存庫伺服器錯誤。
KeyVaultError	金鑰保存庫錯誤例外狀況。
SasDefinitionAttributes	SAS 定義管理屬性。
SasDefinitionBundle	SAS 定義組合包含金鑰保存庫 SAS 定義詳細資料及其屬性。
SasTokenType	SAS 定義將建立的SAS令牌類型。

DeletionRecoveryLevel

反映目前對目前保存庫中記憶體帳戶生效的刪除復原層級。如果它包含「可清除」，則具特殊許可權的使用者可以永久刪除記憶體帳戶;否則，只有系統可以在保留間隔結束時清除記憶體帳戶。

名稱	類型	Description
CustomizedRecoverable	string	表示可復原刪除的保存庫狀態，而無法立即和永久刪除 (亦即當 7<= SoftDeleteRetentionInDays < 90) 時清除。此層級保證在保留間隔期間和訂用帳戶仍可使用時，已刪除實體的復原能力。
CustomizedRecoverable+ProtectedSubscription	string	表示保存庫和訂用帳戶狀態，也就是不允許刪除、立即和永久刪除 (，也就是不允許清除) ，而且當 7<= SoftDeleteRetentionInDays < 90 時，訂用帳戶本身便無法永久取消。此層級保證在保留間隔期間刪除的實體可復原性，也會反映無法取消訂閱本身的事實。
CustomizedRecoverable+Purgeable	string	表示可復原刪除的保存庫狀態，也允許立即和永久刪除 (亦即當 7<= SoftDeleteRetentionInDays < 90) 時清除。除非要求清除作業或取消訂閱，否則此層級保證在保留間隔期間已刪除實體的復原能力。
Purgeable	string	表示保存庫狀態，其中刪除是無法復原的作業，而不會有復原的可能性。此層級對應至無法用於刪除作業的保護;接受實體層級或更高 (保存庫、資源群組、訂用帳戶等刪除作業時，數據會無法復原。)
Recoverable	string	表示可復原刪除的保存庫狀態，而無法立即和永久刪除 (亦即清除) 。此層級保證刪除實體在保留間隔期間 (90 天) 且訂閱仍可供使用時復原。系統會在 90 天后永久刪除，如果未復原
Recoverable+ProtectedSubscription	string	表示保存庫和訂用帳戶狀態，其中刪除可在保留間隔內復原， (90 天) 、立即和永久刪除 (亦即不允許清除) ，以及訂用帳戶本身無法永久取消。系統會在 90 天后永久刪除，如果未復原
Recoverable+Purgeable	string	表示可復原刪除的保存庫狀態，也允許立即和永久刪除 (亦即清除) 。此層級保證刪除實體在保留間隔期間 (90 天) 的復原能力，除非要求清除作業，或取消訂閱。系統會在 90 天后永久刪除，如果未復原

Error

金鑰儲存庫伺服器錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	Error	金鑰儲存庫伺服器錯誤。
message	string	錯誤訊息。

KeyVaultError

金鑰保存庫錯誤例外狀況。

名稱	類型	Description
error	Error	金鑰儲存庫伺服器錯誤。

SasDefinitionAttributes

SAS 定義管理屬性。

名稱	類型	Description
created	integer	以 UTC 為單位的建立時間。
enabled	boolean	對象的啟用狀態。
recoverableDays	integer	softDelete 數據保留天數。啟用 softDelete 時，值應為 =7 和 <=90，否則為 >0。
recoveryLevel	DeletionRecoveryLevel	反映目前在目前保存庫中 SAS 定義的刪除復原層級。如果它包含「可清除」，則特殊許可權使用者可以永久刪除 SAS 定義;否則，只有系統可以在保留間隔結束時清除 SAS 定義。
updated	integer	上次以UTC為單位的更新時間。

SasDefinitionBundle

SAS 定義組合包含金鑰保存庫 SAS 定義詳細資料及其屬性。

名稱	類型	Description
attributes	SasDefinitionAttributes	SAS 定義屬性。
id	string	SAS 定義識別碼。
sasType	SasTokenType	SAS 定義將建立的SAS令牌類型。
sid	string	儲存體帳戶 SAS 定義秘密識別碼。
tags	object	以機碼/值組形式的應用程式特定元數據
templateUri	string	使用任意金鑰簽署的 SAS 定義令牌範本。根據SAS定義建立的令牌會有與範本相同的屬性。
validityPeriod	string	根據 SAS 定義建立的 SAS 令牌有效期間。

SasTokenType

SAS 定義將建立的SAS令牌類型。

名稱	類型	Description
account	string
service	string

共用方式為