Update Secret - Update Secret

Referentie

Service:: Key Vault

API Version:: 7.4

Updates de kenmerken die zijn gekoppeld aan een opgegeven geheim in een bepaalde sleutelkluis.
De UPDATE-bewerking wijzigt opgegeven kenmerken van een bestaand opgeslagen geheim. Kenmerken die niet zijn opgegeven in de aanvraag, blijven ongewijzigd. De waarde van een geheim zelf kan niet worden gewijzigd. Voor deze bewerking is de machtiging geheimen/instellen vereist.

PATCH {vaultBaseUrl}/secrets/{secret-name}/{secret-version}?api-version=7.4

URI-parameters

Name	In	Vereist	Type	Description
secret-name	path	True	string	De naam van het geheim.
secret-version	path	True	string	De versie van het geheim.
vaultBaseUrl	path	True	string	De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
attributes	SecretAttributes	De geheime beheerkenmerken.
contentType	string	Type van de geheime waarde, zoals een wachtwoord.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.

Antwoorden

Name	Type	Description
200 OK	SecretBundle	Het bijgewerkte geheim.
Other Status Codes	KeyVaultError	Key Vault foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

UpdateSecret

Sample Request

HTTP

PATCH https://myvault.vault.azure.net//secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441?api-version=7.4

{
  "tags": {
    "mytag": "myvalue"
  },
  "contentType": "myContentType",
  "attributes": {
    "enabled": true
  }
}

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441",
  "contentType": "myContentType",
  "attributes": {
    "enabled": true,
    "created": 1493938459,
    "updated": 1493938459,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "mytag": "myvalue"
  }
}

Definities

Name	Description
DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor geheimen in de huidige kluis. Als het 'Opschoonbaar' bevat, kan het geheim permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem het geheim aan het einde van het retentie-interval opschonen.
Error	De sleutelkluisserverfout.
KeyVaultError	De foutuitzondering voor de sleutelkluis.
SecretAttributes	De geheime beheerkenmerken.
SecretBundle	Een geheim dat bestaat uit een waarde, id en de bijbehorende kenmerken.
SecretUpdateParameters	De parameters voor het bijwerken van geheimen.

DeletionRecoveryLevel

Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor geheimen in de huidige kluis. Als het 'Opschoonbaar' bevat, kan het geheim permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem het geheim aan het einde van het retentie-interval opschonen.

Name	Type	Description
CustomizedRecoverable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en zolang het abonnement nog beschikbaar is.
CustomizedRecoverable+ProtectedSubscription	string	Geeft een kluis- en abonnementstatus aan waarin verwijdering kan worden hersteld, onmiddellijke en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet definitief kan worden geannuleerd wanneer 7<= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.
CustomizedRecoverable+Purgeable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
Purgeable	string	Geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid voor herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Verwijderbewerking; de gegevens gaan onherroepelijk verloren bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort)
Recoverable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen) en zolang het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+ProtectedSubscription	string	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen een retentieperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet definitief kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+Purgeable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen leegmaken). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen), tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld

Error

De sleutelkluisserverfout.

Name	Type	Description
code	string	De foutcode.
innererror	Error	De sleutelkluisserverfout.
message	string	Het foutbericht.

KeyVaultError

De foutuitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

SecretAttributes

De geheime beheerkenmerken.

Name	Type	Description
created	integer	Aanmaaktijd in UTC.
enabled	boolean	Bepaalt of het object is ingeschakeld.
exp	integer	Vervaldatum in UTC.
nbf	integer	Niet vóór datum in UTC.
recoverableDays	integer	softDelete dagen voor gegevensretentie. De waarde moet =7 en <=90 zijn wanneer softDelete is >ingeschakeld, anders 0.
recoveryLevel	DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor geheimen in de huidige kluis. Als het 'Opschoonbaar' bevat, kan het geheim permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem het geheim aan het einde van het retentie-interval opschonen.
updated	integer	Tijdstip laatst bijgewerkt in UTC.

SecretBundle

Een geheim dat bestaat uit een waarde, id en de bijbehorende kenmerken.

Name	Type	Description
attributes	SecretAttributes	De geheime beheerkenmerken.
contentType	string	Het inhoudstype van het geheim.
id	string	De geheime id.
kid	string	Als dit een geheime back-up is van een KV-certificaat, geeft dit veld de bijbehorende sleutel op die het KV-certificaat moet opgeven.
managed	boolean	Waar als de levensduur van het geheim wordt beheerd door de sleutelkluis. Als dit een geheim is dat een certificaat back-up maakt, is beheerd waar.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.
value	string	De geheime waarde.

SecretUpdateParameters

De parameters voor het bijwerken van geheimen.

Name	Type	Description
attributes	SecretAttributes	De geheime beheerkenmerken.
contentType	string	Type van de geheime waarde, zoals een wachtwoord.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.