Partager via

Set Sas Definition - Set Sas Definition

  • Référence
Service:
Key Vault
Version d'API:
7.4

Crée ou met à jour une nouvelle définition SAS pour le compte de stockage spécifié. Cette opération nécessite l’autorisation storage/setsas.

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

Paramètres URI

Nom Dans Obligatoire Type Description
sas-definition-name
 path True

string

Nom de la définition SAS. La valeur que vous fournissez peut être copiée globalement dans le but d’exécuter le service. La valeur fournie ne doit pas inclure d’informations d’identification personnelle ou sensibles.

Modèle d’expression régulière: ^[0-9a-zA-Z]+$
storage-account-name
 path True

string

Nom du compte de stockage.

Modèle d’expression régulière: ^[0-9a-zA-Z]+$
vaultBaseUrl
 path True

string

Nom du coffre, par exemple https://myvault.vault.azure.net.
api-version
 query True

string

Version d’API client.

Corps de la demande

Nom Obligatoire Type Description
sasType True

SasTokenType

Type de jeton SAS que la définition SAS va créer.
templateUri True

string

Modèle de jeton de définition SAS signé avec une clé arbitraire. Les jetons créés selon la définition SAS auront les mêmes propriétés que le modèle.
validityPeriod True

string

Période de validité des jetons SAS créés en fonction de la définition SAS.
attributes

SasDefinitionAttributes

Attributs de la définition SAS.
tags

object

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

Réponses

Nom Type Description
200 OK

SasDefinitionBundle

Définition SAS créée.
Other Status Codes

KeyVaultError

Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

Set Storage Sas definition

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
  }
}

Définitions

Nom Description
DeletionRecoveryLevel

Reflète le niveau de récupération de suppression actuellement en vigueur pour les comptes de stockage dans le coffre actuel. S’il contient « Purgeable », le compte de stockage peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le compte de stockage à la fin de l’intervalle de rétention.
Error

Erreur du serveur du coffre de clés.
KeyVaultError

Exception d’erreur du coffre de clés.
SasDefinitionAttributes

Attributs de gestion des définitions SAS.
SasDefinitionBundle

Un bundle de définitions SAS se compose de détails de définition SAS de coffre de clés ainsi que de ses attributs.
SasDefinitionCreateParameters

La définition SAS crée des paramètres.
SasTokenType

Type de jeton SAS que la définition SAS va créer.

DeletionRecoveryLevel

Reflète le niveau de récupération de suppression actuellement en vigueur pour les comptes de stockage dans le coffre actuel. S’il contient « Purgeable », le compte de stockage peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le compte de stockage à la fin de l’intervalle de rétention.

Nom Type Description
CustomizedRecoverable

string

Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, vidage lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant que l’abonnement est toujours disponible.
CustomizedRecoverable+ProtectedSubscription

string

Indique un état de coffre et d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et définitive (c’est-à-dire le vidage) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement lorsque 7<= SoftDeleteRetentionInDays < 90. Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et reflète également le fait que l’abonnement lui-même ne peut pas être annulé.
CustomizedRecoverable+Purgeable

string

Désigne un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (par exemple, la suppression lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de vidage est demandée ou que l’abonnement est annulé.
Purgeable

string

Indique un état de coffre dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection disponible contre une opération De suppression ; les données sont irrémédiablement perdues lors de l’acceptation d’une opération De suppression au niveau de l’entité ou au niveau supérieur (coffre, groupe de ressources, abonnement, etc.)
Recoverable

string

Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, vidage). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et pendant que l’abonnement est toujours disponible. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+ProtectedSubscription

string

Indique un état de coffre et d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire le vidage) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+Purgeable

string

Désigne un état de coffre dans lequel la suppression est récupérable, et qui permet également la suppression immédiate et définitive (c’est-à-dire le vidage). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de vidage est demandée ou que l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré

Error

Erreur du serveur du coffre de clés.

Nom Type Description
code

string

Code d'erreur.
innererror

Error

Erreur du serveur du coffre de clés.
message

string

Message d’erreur.

KeyVaultError

Exception d’erreur du coffre de clés.

Nom Type Description
error

Error

Erreur du serveur du coffre de clés.

SasDefinitionAttributes

Attributs de gestion des définitions SAS.

Nom Type Description
created

integer

Heure de création en UTC.
enabled

boolean

état activé de l’objet .
recoverableDays

integer

softDelete data retention days. La valeur doit être >=7 et <=90 lorsque softDelete est activé, sinon 0.
recoveryLevel

DeletionRecoveryLevel

Reflète le niveau de récupération de suppression actuellement en vigueur pour les définitions SAP dans le coffre actuel. S’il contient « Purgeable », la définition SAS peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la définition SAS, à la fin de l’intervalle de rétention.
updated

integer

Heure de la dernière mise à jour au format UTC.

SasDefinitionBundle

Un bundle de définitions SAS se compose de détails de définition SAS de coffre de clés ainsi que de ses attributs.

Nom Type Description
attributes

SasDefinitionAttributes

Attributs de définition SAS.
id

string

ID de définition SAS.
sasType

SasTokenType

Type de jeton SAS que la définition SAS va créer.
sid

string

ID de secret de définition SAS du compte de stockage.
tags

object

Métadonnées spécifiques à l’application sous la forme de paires clé-valeur
templateUri

string

Modèle de jeton de définition SAS signé avec une clé arbitraire. Les jetons créés selon la définition SAS auront les mêmes propriétés que le modèle.
validityPeriod

string

Période de validité des jetons SAS créés en fonction de la définition SAS.

SasDefinitionCreateParameters

La définition SAS crée des paramètres.

Nom Type Description
attributes

SasDefinitionAttributes

Attributs de la définition SAS.
sasType

SasTokenType

Type de jeton SAS que la définition SAS va créer.
tags

object

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.
templateUri

string

Modèle de jeton de définition SAS signé avec une clé arbitraire. Les jetons créés selon la définition SAS auront les mêmes propriétés que le modèle.
validityPeriod

string

Période de validité des jetons SAS créés en fonction de la définition SAS.

SasTokenType

Type de jeton SAS que la définition SAS va créer.

Nom Type Description
account

string

service

string