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

Set Sas Definition - Set Sas Definition

服务:: Key Vault

API 版本:: 7.4

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

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

URI 参数

名称	在	必需	类型	说明
sas-definition-name	path	True	string pattern: ^[0-9a-zA-Z]+$	SAS 定义的名称。为了运行服务，可能会全局复制你提供的值。提供的值不应包含个人身份或敏感信息。
storage-account-name	path	True	string 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	Key Vault 错误响应，描述作失败的原因。

示例

Set Storage Sas definition

示例请求

HTTP

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
  }
}

示例响应

状态代码:: 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	表示一个保管库状态，在该状态下可以恢复删除，且无法立即和永久删除（即当 7<= SoftDeleteRetentionInDays < 90 时清除）。此级别保证在保留时间间隔内以及订阅仍可用期间已删除实体的可恢复性。
CustomizedRecoverable+ProtectedSubscription	表示不允许恢复、立即和永久删除（即清除）的保管库和订阅状态，当 7<= SoftDeleteRetentionInDays < 90 时，订阅本身将无法永久取消。此级别保证在保留时间间隔内删除实体的可恢复性，还反映了无法取消订阅本身的事实。
CustomizedRecoverable+Purgeable	表示可恢复删除的保管库状态，同时允许立即和永久删除（即在 7<= SoftDeleteRetentionInDays < 90 时清除）。此级别保证在保留间隔期间删除的实体的可恢复性，除非请求清除作或取消订阅。
Purgeable	表示删除作不可逆的保管库状态，而无法进行恢复。此级别对应于不可用于删除作的保护;在接受实体级别或更高级别的删除作（保管库、资源组、订阅等）时，数据将不可挽回地丢失。
Recoverable	表示可恢复删除的保管库状态，而无法立即和永久删除（即清除）。此级别保证在保留间隔（90 天）期间删除的实体的可恢复性，同时订阅仍可用。系统在 90 天后永久删除它（如果未恢复）
Recoverable+ProtectedSubscription	表示不允许在保留间隔（90 天）、立即和永久删除（即清除）内恢复删除的保管库和订阅状态，并且不允许永久取消订阅本身。系统在 90 天后永久删除它（如果未恢复）
Recoverable+Purgeable	表示可恢复删除的保管库状态，同时允许立即和永久删除（即清除）。此级别保证在保留间隔（90 天）期间删除的实体的可恢复性，除非请求清除作或取消订阅。系统在 90 天后永久删除它（如果未恢复）

Error

Object

密钥保管库服务器错误。

名称	类型	说明
code	string	错误代码。
innererror	Error	密钥保管库服务器错误。
message	string	错误消息。

KeyVaultError

Object

密钥保管库错误异常。

名称	类型	说明
error	Error	密钥保管库服务器错误。

SasDefinitionAttributes

Object

SAS 定义管理属性。

名称	类型	说明
created	integer (unixtime)	以 UTC 为单位的创建时间。
enabled	boolean	对象的启用状态。
recoverableDays	integer (int32)	softDelete 数据保留天数。启用 softDelete 时，值应 >=7，<=90;否则为 0。
recoveryLevel	DeletionRecoveryLevel	反映当前保管库中 SAS 定义的删除恢复级别。如果它包含“可清除”，则 SAS 定义可由特权用户永久删除;否则，只有系统可以在保留间隔结束时清除 SAS 定义。
updated	integer (unixtime)	UTC 的上次更新时间。

SasDefinitionBundle

Object

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

Object

SAS 定义创建参数。

名称	类型	说明
attributes	SasDefinitionAttributes	SAS 定义的属性。
sasType	SasTokenType	SAS 定义将创建的 SAS 令牌的类型。
tags	object	以键值对的形式的应用程序特定元数据。
templateUri	string	使用任意密钥签名的 SAS 定义令牌模板。根据 SAS 定义创建的令牌将具有与模板相同的属性。
validityPeriod	string	根据 SAS 定义创建的 SAS 令牌的有效期。

SasTokenType

枚举

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

值	说明
account
service

通过

Set Sas Definition - Set Sas Definition

URI 参数

请求正文

响应

示例

Set Storage Sas definition

示例请求

示例响应

定义

DeletionRecoveryLevel

Error

KeyVaultError

SasDefinitionAttributes

SasDefinitionBundle

SasDefinitionCreateParameters

SasTokenType