Set Sas Definition - Set Sas Definition

Serviço:: Key Vault

Versão da API:: 7.4

Cria ou atualiza uma nova definição de SAS para a conta de armazenamento especificada. Esta operação requer a permissão storage/setsas.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
sas-definition-name	path	True	string pattern: ^[0-9a-zA-Z]+$	O nome da definição SAS. O valor fornecido pode ser copiado globalmente com a finalidade de executar o serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais.
storage-account-name	path	True	string pattern: ^[0-9a-zA-Z]+$	O nome da conta de armazenamento.
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo, `https://myvault.vault.azure.net`.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
sasType	True	SasTokenType	O tipo de token SAS que a definição SAS criará.
templateUri	True	string	O modelo de token de definição SAS assinado com uma chave arbitrária. Os tokens criados de acordo com a definição SAS terão as mesmas propriedades que o modelo.
validityPeriod	True	string	O período de validade dos tokens SAS criados de acordo com a definição SAS.
attributes		SasDefinitionAttributes	Os atributos da definição SAS.
tags		object	Metadados específicos do aplicativo na forma de pares chave-valor.

Respostas

Name	Tipo	Description
200 OK	SasDefinitionBundle	A definição de SAS criada.
Other Status Codes	KeyVaultError	Resposta de erro do Key Vault descrevendo por que a operação falhou.

Exemplos

Set Storage Sas definition

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
  }
}

Definições

Name	Description
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para contas de armazenamento no cofre atual. Se contiver 'Purgeable', a conta de armazenamento pode ser permanentemente excluída por um usuário privilegiado; caso contrário, apenas o sistema pode limpar a conta de armazenamento, no final do intervalo de retenção.
Error	O erro do servidor do cofre de chaves.
KeyVaultError	A exceção de erro do cofre de chaves.
SasDefinitionAttributes	Os atributos de gerenciamento de definição SAS.
SasDefinitionBundle	Um pacote de definição SAS consiste em detalhes de definição SAS do cofre de chaves mais seus atributos.
SasDefinitionCreateParameters	A definição SAS cria parâmetros.
SasTokenType	O tipo de token SAS que a definição SAS criará.

DeletionRecoveryLevel

Enumeração

Reflete o nível de recuperação de exclusão atualmente em vigor para contas de armazenamento no cofre atual. Se contiver 'Purgeable', a conta de armazenamento pode ser permanentemente excluída por um usuário privilegiado; caso contrário, apenas o sistema pode limpar a conta de armazenamento, no final do intervalo de retenção.

Valor	Description
CustomizedRecoverable	Indica um estado vault no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, purga quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e enquanto a assinatura ainda estiver disponível.
CustomizedRecoverable+ProtectedSubscription	Indica um estado de cofre e assinatura no qual a exclusão é recuperável, a exclusão imediata e permanente (ou seja, a limpeza) não é permitida e na qual a assinatura em si não pode ser permanentemente cancelada quando 7<= SoftDeleteRetentionInDays < 90. Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e também reflete o fato de que a assinatura em si não pode ser cancelada.
CustomizedRecoverable+Purgeable	Indica um estado vault no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, purga quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção, a menos que uma operação Purge seja solicitada ou a assinatura seja cancelada.
Purgeable	Indica um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Este nível corresponde a nenhuma proteção disponível contra uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação de Exclusão no nível da entidade ou superior (cofre, grupo de recursos, assinatura, etc.)
Recoverable	Indica um estado vault no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, purga). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias) e enquanto a assinatura ainda estiver disponível. O sistema irá excluí-lo permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription	Indica um estado de cofre e assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente. O sistema irá excluí-lo permanentemente após 90 dias, se não for recuperado
Recoverable+Purgeable	Indica um estado vault no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias), a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. O sistema irá excluí-lo permanentemente após 90 dias, se não for recuperado

Error

Object

O erro do servidor do cofre de chaves.

Name	Tipo	Description
code	string	O código de erro.
innererror	Error	O erro do servidor do cofre de chaves.
message	string	A mensagem de erro.

KeyVaultError

Object

A exceção de erro do cofre de chaves.

Name	Tipo	Description
error	Error	O erro do servidor do cofre de chaves.

SasDefinitionAttributes

Object

Os atributos de gerenciamento de definição SAS.

Name	Tipo	Description
created	integer (unixtime)	Hora de criação em UTC.
enabled	boolean	O estado habilitado do objeto.
recoverableDays	integer (int32)	softDelete dias de retenção de dados. O valor deve ser >=7 e <=90 quando softDelete ativado, caso contrário, 0.
recoveryLevel	DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para definições de SAS no cofre atual. Se contiver 'Purgeable', a definição SAS pode ser permanentemente eliminada por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar a definição SAS, no final do intervalo de retenção.
updated	integer (unixtime)	Última atualização em UTC.

SasDefinitionBundle

Object

Um pacote de definição SAS consiste em detalhes de definição SAS do cofre de chaves mais seus atributos.

Name	Tipo	Description
attributes	SasDefinitionAttributes	Os atributos de definição SAS.
id	string	A definição de SAS id.
sasType	SasTokenType	O tipo de token SAS que a definição SAS criará.
sid	string	ID secreto da definição SAS da conta de armazenamento.
tags	object	Metadados específicos do aplicativo na forma de pares chave-valor
templateUri	string	O modelo de token de definição SAS assinado com uma chave arbitrária. Os tokens criados de acordo com a definição SAS terão as mesmas propriedades que o modelo.
validityPeriod	string	O período de validade dos tokens SAS criados de acordo com a definição SAS.

SasDefinitionCreateParameters

Object

A definição SAS cria parâmetros.

Name	Tipo	Description
attributes	SasDefinitionAttributes	Os atributos da definição SAS.
sasType	SasTokenType	O tipo de token SAS que a definição SAS criará.
tags	object	Metadados específicos do aplicativo na forma de pares chave-valor.
templateUri	string	O modelo de token de definição SAS assinado com uma chave arbitrária. Os tokens criados de acordo com a definição SAS terão as mesmas propriedades que o modelo.
validityPeriod	string	O período de validade dos tokens SAS criados de acordo com a definição SAS.

SasTokenType

Enumeração

O tipo de token SAS que a definição SAS criará.

Valor	Description
account
service

Partilhar via

Set Sas Definition - Set Sas Definition

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Set Storage Sas definition

Pedido de amostra

Resposta da amostra

Definições

DeletionRecoveryLevel

Error

KeyVaultError

SasDefinitionAttributes

SasDefinitionBundle

SasDefinitionCreateParameters

SasTokenType