你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set Sas Definition - Set Sas Definition

  • 参考
Service:
Key Vault
API Version:
7.4

为指定的存储帐户创建或更新新的 SAS 定义。 此操作需要 storage/setsas 权限。

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

URI 参数

名称 在 必需 类型 说明
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 版本。

请求正文

名称 必需 类型 说明
sasType True

SasTokenType

SAS 定义将创建的 SAS 令牌的类型。
templateUri True

string

使用任意密钥签名的 SAS 定义令牌模板。 根据 SAS 定义创建的令牌将具有与模板相同的属性。
validityPeriod True

string

根据 SAS 定义创建的 SAS 令牌的有效期。
attributes

SasDefinitionAttributes

SAS 定义的属性。
tags

object

键/值对形式的应用程序特定元数据。

响应

名称 类型 说明
200 OK

SasDefinitionBundle

创建的 SAS 定义。
Other Status Codes

KeyVaultError

密钥保管库描述操作失败原因的错误响应。

示例

Set Storage Sas definition

Sample Request

PUT https://myvault.vault.azure.net//storage/setsas01/sas/setStrgSasDef01?api-version=7.4

{
  "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D",
  "sasType": "service",
  "validityPeriod": "P15D",
  "attributes": {
    "enabled": true
  }
}

Sample Response

Status code:
200 
{
  "id": "https://myvault.vault.azure.net/storage/setsas01/sas/setStrgSasDef01",
  "sid": "https://myvault.vault.azure.net/secrets/setsas01-setStrgSasDef01",
  "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"
  }
}

定义

名称 说明
DeletionRecoveryLevel

反映当前保管库中存储帐户当前生效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除存储帐户;否则，只有系统才能在保留间隔结束时清除存储帐户。
Error

密钥保管库服务器错误。
KeyVaultError

密钥保管库错误异常。
SasDefinitionAttributes

SAS 定义管理属性。
SasDefinitionBundle

SAS 定义捆绑包由密钥保管库 SAS 定义详细信息及其属性组成。
SasDefinitionCreateParameters

SAS 定义创建参数。
SasTokenType

SAS 定义将创建的 SAS 令牌的类型。

DeletionRecoveryLevel

反映当前保管库中存储帐户当前生效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除存储帐户;否则，只有系统才能在保留间隔结束时清除存储帐户。

名称 类型 说明
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

密钥保管库服务器错误。

名称 类型 说明
code

string

错误代码。
innererror

Error

密钥保管库服务器错误。
message

string

错误消息。

KeyVaultError

密钥保管库错误异常。

名称 类型 说明
error

Error

密钥保管库服务器错误。

SasDefinitionAttributes

SAS 定义管理属性。

名称 类型 说明
created

integer

创建时间（UTC）。
enabled

boolean

对象的启用状态。
recoverableDays

integer

softDelete 数据保留天数。 启用 softDelete 时，值应为 >=7 和 <=90，否则为 0。
recoveryLevel

DeletionRecoveryLevel

反映当前保管库中 SAS 定义当前生效的删除恢复级别。 如果它包含“可清除”，则特权用户可以永久删除 SAS 定义;否则，只有系统才能在保留间隔结束时清除 SAS 定义。
updated

integer

上次更新时间（UTC）。

SasDefinitionBundle

SAS 定义捆绑包由密钥保管库 SAS 定义详细信息及其属性组成。

名称 类型 说明
attributes

SasDefinitionAttributes

SAS 定义属性。
id

string

SAS 定义 ID。
sasType

SasTokenType

SAS 定义将创建的 SAS 令牌的类型。
sid

string

存储帐户 SAS 定义机密 ID。
tags

object

键值对形式的特定于应用程序的元数据
templateUri

string

使用任意密钥签名的 SAS 定义令牌模板。 根据 SAS 定义创建的令牌将具有与模板相同的属性。
validityPeriod

string

根据 SAS 定义创建的 SAS 令牌的有效期。

SasDefinitionCreateParameters

SAS 定义创建参数。

名称 类型 说明
attributes

SasDefinitionAttributes

SAS 定义的属性。
sasType

SasTokenType

SAS 定义将创建的 SAS 令牌的类型。
tags

object

键/值对形式的应用程序特定元数据。
templateUri

string

使用任意密钥签名的 SAS 定义令牌模板。 根据 SAS 定义创建的令牌将具有与模板相同的属性。
validityPeriod

string

根据 SAS 定义创建的 SAS 令牌的有效期。

SasTokenType

SAS 定义将创建的 SAS 令牌的类型。

名称 类型 说明
account

string

service

string