Aracılığıyla paylaş

JavaScript için Azure Key Vault Yönetim istemci kitaplığı - sürüm 4.7.0

Azure Key Vault Yönetilen HSM, FIPS 140-2 Düzey 3 doğrulanmış HSM'leri kullanarak bulut uygulamalarınız için şifreleme anahtarlarını korumanızı sağlayan, tam olarak yönetilen, yüksek oranda kullanılabilir, tek kiracılı, standartlara uyumlu bir bulut hizmetidir. Azure Key Vault Yönetilen HSM hakkında daha fazla bilgi edinmek isterseniz şunları gözden geçirmek isteyebilirsiniz: Azure Key Vault Yönetilen HSM nedir?

Paket @azure/keyvault-admin tam yedekleme/geri yükleme ve anahtar düzeyinde rol tabanlı erişim denetimi (RBAC) gibi yönetim Key Vault görevleri için destek sağlar.

Not: Yönetim kitaplığı yalnızca Azure Key Vault Yönetilen HSM ile çalışır. Key Vault'un hedeflenmesine neden olan işlevler başarısız olur.

Not: Azure Key Vault hizmet sınırlamaları nedeniyle bu paket tarayıcıda kullanılamıyor, yönergeler için lütfen bu belge bakın.

Önemli bağlantılar:

Başlangıç Yapmak

Paketi yükle

NPMile JavaScript ve TypeScript için Azure Key Vault yönetim istemci kitaplığını yükleyin:

npm install @azure/keyvault-admin

TypeScript'i yapılandırma

TypeScript kullanıcılarının Düğüm türü tanımlarının yüklü olması gerekir:

npm install @types/node

ayrıca tsconfig.jsoncompilerOptions.allowSyntheticDefaultImports etkinleştirmeniz gerekir. compilerOptions.esModuleInteropetkinleştirdiyseniz allowSyntheticDefaultImports varsayılan olarak etkin olduğunu unutmayın. Daha fazla bilgi için bkz. TypeScript'in derleyici seçenekleri el kitabı.

Şu anda desteklenen ortamlar

Önkoşullar

İstemcinin kimliğini doğrulama

Azure Key Vault hizmetiyle etkileşim kurmak için KeyVaultAccessControlClient sınıfının veya KeyVaultBackupClient sınıfının bir örneğinin yanı sıra kasa url'si (Azure Portalda "DNS Adı" olarak görebileceğiniz) ve bir kimlik bilgisi nesnesi oluşturmanız gerekir. Bu belgede gösterilen örneklerde, yerel geliştirme ve üretim ortamları dahil olmak üzere çoğu senaryo için uygun olan DefaultAzureCredentialadlı bir kimlik bilgisi nesnesi kullanılır. Ayrıca, üretim ortamlarında kimlik doğrulaması için yönetilen kimlik kullanmanızı öneririz.

Kimlik doğrulamasının farklı yolları ve bunların ilgili kimlik bilgileri türleri hakkında daha fazla bilgiyi Azure Kimliği belgelerinde bulabilirsiniz.

KeyVaultAccessControlClient Oluşturma

size en uygun kimlik doğrulama yönteminikimlik doğrulaması yaptıktan sonra, oluşturucuda Yönetilen HSM URL'nizin yerine aşağıdaki gibi bir KeyVaultAccessControlClient oluşturabilirsiniz:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

KeyVaultBackupClient Oluşturma

size en uygun kimlik doğrulama yönteminikimlik doğrulaması yaptıktan sonra, oluşturucuda Yönetilen HSM URL'nizin yerine aşağıdaki gibi bir KeyVaultBackupClient oluşturabilirsiniz:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultBackupClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, credentials);

Temel kavramlar

KeyVaultRoleDefinition

Rol Tanımı bir izin koleksiyonudur. Rol tanımı okuma, yazma ve silme gibi gerçekleştirilebilecek işlemleri tanımlar. İzin verilen işlemlerin dışında tutulan işlemleri de tanımlayabilir.

Rol tanımları bir KeyVaultRoleAssignmentparçası olarak listelenebilir ve belirtilebilir.

KeyVaultRoleAssignment (Anahtar KasasıRol Atama)

Rol Ataması, rol tanımının hizmet sorumlusuyla ilişkisidir. Bunlar oluşturulabilir, listelenebilir, tek tek getirilebilir ve silinebilir.

KeyVaultAccessControlClient

KeyVaultAccessControlClient, Rol Tanımlarının (KeyVaultRoleDefinitionörnekleri) ve Rol Atamalarının (KeyVaultRoleAssignmentörnekleri) yönetilmesine olanak sağlayan işlemler sağlar.

KeyVaultBackupClient

KeyVaultBackupClient tam anahtar yedeklemeleri, tam anahtar geri yüklemeleri ve seçmeli anahtar geri yüklemeleri gerçekleştirme işlemleri sağlar.

Uzun süreli işlemler

KeyVaultBackupClient tarafından yapılan işlemler, Azure kaynaklarının gerektirdiği kadar zaman alabilir ve bitmesini bekleyen programların yaşam döngüsü boyunca bir istemci katmanının işlemleri izlemesini, serileştirmesini ve sürdürmesini gerektirir. Bu, @azure/core-lropaketi aracılığıyla ortak bir soyutlama yoluyla yapılır.

KeyVaultBackupClient, uzun süre çalışan işlemleri yürüten üç yöntem sunar:

  • beginBackup, belirtilen Depolama Blobu hesabında Azure Key Vault Yönetilen HSM'nin yedeğini oluşturmaya başlar.
  • beginRestore, daha önce depolanmış bir Azure Blob depolama yedekleme klasörüne işaret eden SAS belirtecini kullanarak tüm önemli malzemeleri geri yüklemeye başlar.
  • beginSelectiveRestore, kullanıcı tarafından sağlanan SAS belirtecini kullanarak daha önce depolanmış bir Azure Blob depolama yedekleme klasörüne işaret eden belirli bir anahtarın tüm anahtar sürümlerini geri yüklemeye başlar.

Uzun süre çalışan işlemlere başlayan yöntemler, işlem tamamlanana kadar süresiz olarak beklemenizi sağlayan bir poller döndürür. Aşağıdaki örneklerde daha fazla bilgi bulabilirsiniz.

Örnekler

Hem JavaScript hem de TypeScript'te bu paketteki erişim denetimi ve yedekleme/geri yükleme özelliklerini gösteren örneklerimiz var. Örnekleri çalıştırmak için ayrıntılı adımlar için lütfen ilgili benioku'ları izleyin.

Sorun giderme

Çeşitli hata senaryolarını tanılama hakkında ayrıntılı bilgi için sorun giderme kılavuzumuza bakın.

Loglamayı etkinleştirmek, hatalarla ilgili yararlı bilgilerin ortaya çıkmasına yardımcı olabilir. HTTP isteklerinin ve yanıtlarının günlüğünü görmek için ortam değişkenini AZURE_LOG_LEVEL olarak infoayarlayın. Alternatif olarak, çalışma zamanında setLogLevel@azure/logger çağrılarak günlük tutma etkinleştirilebilir.

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Sonraki Adımlar

Aşağıdaki bağlantılardan daha fazla kod örneği bulabilirsiniz:

Katkıda Bulunmak

Bu kitaplığa katkıda bulunmak istiyorsanız kodu oluşturma ve test etme hakkında daha fazla bilgi edinmek için lütfen katkıda bulunma kılavuzu okuyun.

  • Last updated on