Titkos kulcs beállítása, frissítése és elforgatása az Azure Key Vaultban JavaScript használatával

Hozza létre a SecretClientet a megfelelő programozott hitelesítési hitelesítő adatokkal, majd használja az ügyfelet egy titkos kód beállítására, frissítésére és elforgatására az Azure Key Vaultban.

Titkos kód beállítása

Ha titkos kulcsot szeretne beállítani az Azure Key Vaultban, használja a SecretClient osztály setSecret metódusát.

A titkos érték típusa karakterlánc. A kezdeti érték bármi lehet, amely szerializálható egy sztringre, például JSON-ra vagy BASE64-kódolt adatokra. A titkos kulcsnak a Key Vaultban történő beállítása előtt meg kell adnia a szerializálást, és a titkos kulcs Key Vaultból történő lekérése után el kell végeznie a deszerializálást.

const name = 'mySecret';
const value = 'mySecretValue'; // or JSON.stringify({'key':'value'})

const { name, value, properties } = await client.setSecret(
    secretName,
    secretValue
);

A titkos kód létrehozásakor a KeyVaultSecret-válasz tartalmaz egy SecretProperties objektumot, amely tartalmazza a titkos kód metaadatait, például:

  • createdOn: UTC dátum és időpont a titkos kód létrehozásakor.
  • id: Titkos kód teljes URL-címe.
  • recoverableDays: Azon napok száma, amikor a titkos kód helyreállítható a törlés után.
  • recoveryLevel: Az értékek a következők: "Kiüríthető", "Helyreállítható és Kiüríthető", "Helyreállítható", "Helyreállítható és Védett előfizetés".
  • updatedOn: UTC dátum és időpont, amikor a titkos kód utoljára frissült.
  • version: A Titkos verzió.

Titkos kód beállítása tulajdonságokkal

Használja a SecretClient osztály setSecret metódusát a SetSecretOptions használatával az opcionális paraméterek megadására, amelyek a titkos kódhoz kapcsolódnak, például:

  • contentType: A titkos kód tartalomtípusának ábrázolása és megértése. A használati javaslatok közé tartozik egy natív típus, egy saját egyéni TypeScript-típus vagy egy MIME-típus. Ez az érték látható az Azure Portalon.
  • enabled: Alapértelmezés szerint igaz.
  • expiresOn: A titok lejáratának UTC dátuma és ideje.
  • notBefore: UTC dátum és idő, amely előtt a titkos kód nem használható.
  • tags: A titkos kódhoz társítható egyéni név-érték párok.
const name = 'mySecret';
const value = JSON.stringify({
    'mykey':'myvalue', 
    'myEndpoint':'https://myendpoint.com'
});
const secretOptions = {
    // example options
    contentType: 'application/json',
    tags: { 
        project: 'test-cluster', 
        owner: 'jmclane',
        team: 'devops'
    }
};

const { name, value, properties } = await client.setSecret(
    secretName,
    secretValue, 
    secretOptions
);

Ez a metódus a KeyVaultSecret objektumot adja vissza.

Titkos kód értékének frissítése

Titkos kód értékének frissítéséhez használja az előző szakaszban bemutatott setSecret metódust. Ügyeljen arra, hogy sztringként adja át az új értéket, és minden olyan tulajdonságot, amelyet meg szeretne tartani a titkos kód aktuális verziójától. Az aktuális tulajdonságok, amelyeket nem állítanak be a további setSecret hívások során, elvesznek.

Ez létrehoz egy titkos kód új verzióját. A visszaadott SecretProperties objektum tartalmazza az új verzióazonosítót.

Titkos kód tulajdonságainak frissítése

A titkos kódok tulajdonságainak frissítéséhez használja a SecretClient osztály updateSecretProperties metódusát. A kérelemben nem megadott tulajdonságok változatlanok maradnak. Maga a titkos kód értéke nem módosítható. Ehhez a művelethez titkos kulcsok/beállítások megadása szükséges.

const name = 'mySecret';

// Update tags
const updatedTagName = 'existingTag';
const updatedTagValue = secret.properties.version.tags[updatedTagName] + ' additional information';

// Use version from existing secret
const version = secret.properties.version;

// Options to update
const secretOptions = {
    tags: {
        'newTag': 'newTagValue', // Set new tag
        'updatedTag': updatedTagValue // Update existing tag
    },
    enabled: false
}

// Update secret's properties - doesn't change secret name or value
const properties = await client.updateSecretProperties(
    secretName,
    secretVersion,
    secretOptions,
);

This method returns the SecretProperties object.

Egy titok elforgatása

A titkos kódok elforgatásához létre kell hoznia egy Event Grid-esemény-előfizetést a SecretNearExpiry eseményhez, és meg kell adnia az eseményindítókkal meghívandó forgatási funkciókat. Az alábbi oktatóanyagok egyikével automatizálhatja a titkos kódok forgását a használt erőforrások esetében :

Következő lépések

  • Last updated on