@azure/keyvault-admin package

Sınıflar

KeyVaultAccessControlClient

KeyVaultAccessControlClient, belirli bir Azure Key Vault örneğinde erişim denetimini ve rol atamalarını yönetmek için yöntemler sağlar. İstemci rolleri oluşturmayı, almayı ve silmeyi destekler.

KeyVaultBackupClient

KeyVaultBackupClient, belirli bir Azure Key Vault örneğinin yedeklerini oluşturmak ve yedeklemeleri geri yüklemek için yöntemler sağlar. Bu istemci tam yedeklemeler, belirli anahtarların seçmeli geri yüklemeleri ve Key Vault örneklerinin tam geri yüklemelerini destekler.

KeyVaultSettingsClient

KeyVaultSettingsClient, Azure Key Vault ayarlarını oluşturmak, güncelleştirmek, almak ve listelemek için zaman uyumsuz yöntemler sağlar.

Arabirimler

AccessControlClientOptions

Key Vault'un AccessControlClient tarafından kabul edilen isteğe bağlı parametreler

BooleanKeyVaultSetting

Boole türünde bir Key Vault ayarı. Belirli bir KeyVaultSetting değerinin boole değeri olup olmadığını denetlemek için isBooleanSetting kullanın.

CreateRoleAssignmentOptions

createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

DeleteRoleAssignmentOptions

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

DeleteRoleDefinitionOptions

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)geçirilen isteğe bağlı parametreleri temsil eden bir arabirim.

GetRoleAssignmentOptions

getRoleAssignment(string, string, GetRoleAssignmentOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

GetRoleDefinitionOptions

getRoleDefinition(string, string, GetRoleDefinitionOptions)geçirilen isteğe bağlı parametreleri temsil eden bir arabirim.

GetSettingOptions

getSetting geçirilebilen isteğe bağlı parametreleri temsil eden arabirim

KeyVaultAdminPollOperationState

Key Vault Yöneticisi Poller'ın işleminin durumunu temsil eden bir arabirim.

KeyVaultBackupClientOptions

KeyVaultBackupClient tarafından kabul edilen isteğe bağlı parametreler

KeyVaultBackupPollerOptions

beginBackup(string, string, KeyVaultBeginBackupOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

KeyVaultBackupResult

Yedekleme işleminin sonucunu temsil eden arabirim.

KeyVaultBeginBackupOptions

beginBackup geçirilebilen isteğe bağlı parametreleri temsil eden arabirim

KeyVaultBeginPreBackupOptions

beginPreBackup geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

KeyVaultBeginPreRestoreOptions

beginPreRestore geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

KeyVaultBeginRestoreOptions

beginRestore geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

KeyVaultBeginSelectiveKeyRestoreOptions

beginSelectiveKeyRestore geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

KeyVaultPermission

Key Vault izinlerinin listesi.

KeyVaultRestoreOperationState

Geri yükleme Key Vault'un yoklama işleminin durumunun genel kullanıma açık özelliklerini temsil eden arabirim.

KeyVaultRestoreResult

Geri yükleme işleminin sonucunu temsil eden arabirim.

KeyVaultRoleAssignment

Key Vault rol ataması.

KeyVaultRoleAssignmentProperties

Rol atama özellikleri.

KeyVaultRoleDefinition

Key Vault rol tanımı.

KeyVaultSelectiveKeyRestoreOperationState

Geri yükleme Key Vault'un yoklama işleminin durumunun genel kullanıma açık özelliklerini temsil eden arabirim.

KeyVaultSelectiveKeyRestoreResult

Seçmeli anahtar geri yükleme işleminin sonucunu temsil eden arabirim.

KeyVaultSetting

Key Vault ayarı.

ListRoleAssignmentsOptions

listRoleAssignments(string, ListRoleAssignmentsOptions)geçirilen isteğe bağlı parametreleri temsil eden bir arabirim.

ListRoleAssignmentsPageSettings

Arama sonuçlarının sonraki sayfasını almaya yönelik bağımsız değişkenler.

ListRoleDefinitionsOptions

listRoleDefinitions(string, ListRoleDefinitionsOptions)geçirilen isteğe bağlı parametreleri temsil eden bir arabirim.

ListRoleDefinitionsPageSettings

Arama sonuçlarının sonraki sayfasını almaya yönelik bağımsız değişkenler.

ListSettingsOptions

<xref:KeyVaultSettingsClient.listSettings> geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

ListSettingsResponse

<xref:KeyVaultSettingsClient.listSettings> tarafından döndürülen yanıtı temsil eden bir arabirim

PollerLike

Uzun süre çalışan bir işlemi yoklamada kullanılabilecek basit bir poller.

SetRoleDefinitionOptions

setRoleDefinition(string, SetRoleDefinitionOptions)geçirilen isteğe bağlı parametreleri temsil eden bir arabirim.

SettingsClientOptions

KeyVaultSettingsClient tarafından kabul edilen isteğe bağlı parametreler.

UpdateSettingOptions

updateSetting geçirilebilen isteğe bağlı parametreleri temsil eden arabirim

Tür Diğer Adları

KeyVaultBackupOperationState

Yedekleme Key Vault'un yoklama işleminin durumunun genel kullanıma açık özelliklerini temsil eden arabirim.

KeyVaultDataAction

Veri eylemleri için desteklenen izinler.
<xref:KnownDataAction> DataAction ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

Microsoft.KeyVault/managedHsm/keys/read/action: HSM anahtar meta verilerini okuyun.
Microsoft.KeyVault/managedHsm/keys/write/action: HSM anahtarını güncelleştirin.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action : Silinen HSM anahtarını okuyun.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Silinen HSM anahtarını kurtarın.
Microsoft.KeyVault/managedHsm/keys/backup/action: HSM anahtarlarını yedekleyin.
Microsoft.KeyVault/managedHsm/keys/restore/action: HSM anahtarlarını geri yükleyin.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Rol atamasını silin.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Rol ataması alın.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Rol ataması oluşturun veya güncelleştirin.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Rol tanımını alın.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Rol tanımı oluşturun veya güncelleştirin.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Rol tanımını silin.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: HSM anahtarı kullanarak şifreleyin.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: HSM anahtarı kullanarak şifre çözme.
Microsoft.KeyVault/managedHsm/keys/wrap/action: HSM anahtarı kullanarak sarmalayın.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: HSM anahtarı kullanarak sarmayı kaldırın.
Microsoft.KeyVault/managedHsm/keys/sign/action : HSM anahtarı kullanarak imzalayın.
Microsoft.KeyVault/managedHsm/keys/verify/action : HSM anahtarı kullanarak doğrulayın.
Microsoft.KeyVault/managedHsm/keys/create: HSM anahtarı oluşturun.
Microsoft.KeyVault/managedHsm/keys/delete: HSM anahtarını silin.
Microsoft.KeyVault/managedHsm/keys/export/action: HSM anahtarını dışarı aktarın.
Microsoft.KeyVault/managedHsm/keys/release/action: Secure Key Release kullanarak bir HSM anahtarı bırakın.
Microsoft.KeyVault/managedHsm/keys/import/action: HSM anahtarını içeri aktar.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete : Silinen HSM anahtarını temizleme.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: HSM güvenlik etki alanını indirin.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: HSM güvenlik etki alanı indirme durumunu denetleyin.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action : HSM güvenlik etki alanını karşıya yükleyin.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: HSM güvenlik etki alanı değişim dosyasının durumunu denetleyin.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: HSM güvenlik etki alanı aktarım anahtarını indirin.
Microsoft.KeyVault/managedHsm/backup/start/action : HSM yedeklemesi başlatın.
Microsoft.KeyVault/managedHsm/restore/start/action: HSM geri yüklemesini başlatın.
Microsoft.KeyVault/managedHsm/backup/status/action: HSM yedekleme durumunu okuyun.
Microsoft.KeyVault/managedHsm/restore/status/action: HSM geri yükleme durumunu okuyun.
Microsoft.KeyVault/managedHsm/rng/action: Rastgele sayılar oluşturun.

KeyVaultRoleScope

Rol kapsamı.
<xref:KnownRoleScope> RoleScope ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

/: Genel kapsam
/keys: Anahtar kapsamı

OperationStatus

Uzun süre çalışan bir işlemin durumu.
<xref:KnownOperationStatus> OperationStatus ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

InProgress : İşlem devam ediyor.
başarılı : İşlem başarıyla tamamlandı.
İptal Edildi: İşlem iptal edildi.
Başarısız: İşlem başarısız oldu.

SUPPORTED_API_VERSIONS

Desteklenen API sürümleri

Numaralandırmalar

KnownKeyVaultDataAction

Veri eylemleri için desteklenen izinler.

KnownKeyVaultRoleScope

Rol kapsamı.

İşlevler

isBooleanSetting(KeyVaultSetting)

Belirli bir KeyVaultSettingBooleanKeyVaultSettingolup olmadığını belirler; örneğin boole değeri vardır.

Değişkenler

LATEST_API_VERSION

En son desteklenen Key Vault hizmet API sürümü.

SDK_VERSION

Key Vault Admin SDK'nın güncel sürümü.

İşlev Ayrıntıları

isBooleanSetting(KeyVaultSetting)

Belirli bir KeyVaultSettingBooleanKeyVaultSettingolup olmadığını belirler; örneğin boole değeri vardır.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parametreler

setting
KeyVaultSetting

Döndürülenler

setting

Değişken Ayrıntıları

LATEST_API_VERSION

En son desteklenen Key Vault hizmet API sürümü.

LATEST_API_VERSION: "2025-07-01"

Tür

"2025-07-01"

SDK_VERSION

Key Vault Admin SDK'nın güncel sürümü.

SDK_VERSION: string

Tür

string