Partager via

Update Sas Definition - Update Sas Definition

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

Mises à jour les attributs spécifiés associés à la définition SAS donnée. Cette opération nécessite l’autorisation storage/setsas.

PATCH {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 SAP.

Regex pattern: ^[0-9a-zA-Z]+$
storage-account-name
 path True

string

Nom du compte de stockage.

Regex pattern: ^[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 Type Description
attributes

SasDefinitionAttributes

Attributs de la définition SAP.
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 SAP signé avec une clé arbitraire. Les jetons créés selon la définition SAP auront les mêmes propriétés que le modèle.
validityPeriod

string

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

Réponses

Nom Type Description
200 OK

SasDefinitionBundle

Définition SAS mise à jour.
Other Status Codes

KeyVaultError

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

Exemples

Update Storage Sas definition

Sample Request

PATCH https://myvault.vault.azure.net//storage/patchsas01/sas/patchStrgSasDef01?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/patchsas01/sas/patchStrgSasDef01",
  "sid": "https://myvault.vault.azure.net/secrets/patchsas01-patchStrgSasDef01",
  "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 SAP.
SasDefinitionBundle

Une offre groupée de définitions SAP se compose des détails de la définition SAP du coffre de clés ainsi que de ses attributs.
SasDefinitionUpdateParameters

Paramètres de mise à jour de la définition SAP.
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, purger quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et tant 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 permanente (c’est-à-dire la purge) n’est pas autorisée et dans laquelle 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, purge 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 purge est demandée ou si l’abonnement est annulé.
Purgeable

string

Désigne 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 (c’est-à-dire une purge). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et tant 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

Désigne 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 la purge) 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 une suppression immédiate et définitive (c’est-à-dire une purge). 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 purge est demandée ou si 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 SAP.

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 SAP peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la définition SAP, à la fin de l’intervalle de rétention.
updated

integer

Heure de la dernière mise à jour en UTC.

SasDefinitionBundle

Une offre groupée de définitions SAP se compose des détails de la définition SAP du 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 SAP.
sasType

SasTokenType

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

string

ID de secret de définition SAP 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 SAP signé avec une clé arbitraire. Les jetons créés selon la définition SAP auront les mêmes propriétés que le modèle.
validityPeriod

string

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

SasDefinitionUpdateParameters

Paramètres de mise à jour de la définition SAP.

Nom Type Description
attributes

SasDefinitionAttributes

Attributs de la définition SAP.
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 SAP signé avec une clé arbitraire. Les jetons créés selon la définition SAP auront les mêmes propriétés que le modèle.
validityPeriod

string

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

SasTokenType

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

Nom Type Description
account

string

service

string