@azure/arm-keyvault package
Klassen
| KeyVaultManagementClient |
Schnittstellen
| AccessPolicyEntry |
Eine Identität, die Zugriff auf den Schlüsseltresor hat. Alle Identitäten im Array müssen dieselbe Mandanten-ID wie die Mandanten-ID des Schlüsseltresors verwenden. |
| Action |
Modellschnittstellen-Aktion |
| Attributes |
Die vom KeyVault-Dienst verwalteten Objektattribute. |
| CheckMhsmNameAvailabilityParameters |
Die Parameter, die verwendet werden, um die Verfügbarkeit des verwalteten hsm-Namens zu überprüfen. |
| CheckMhsmNameAvailabilityResult |
Die Antwort des CheckMhsmNameAvailability-Vorgangs. |
| CheckNameAvailabilityResult |
Die Antwort des CheckNameAvailability-Vorgangs. |
| CloudError |
Fehlerantwort des Key Vault-Ressourcenanbieters |
| CloudErrorBody |
Fehlerantwort des Key Vault-Ressourcenanbieters |
| DeletedManagedHsm |
Konkrete Proxyressourcentypen können durch Aliasing dieses Typs mithilfe eines bestimmten Eigenschaftstyps erstellt werden. |
| DeletedManagedHsmProperties |
Eigenschaften des gelöschten verwalteten HSM. |
| DeletedVault |
Gelöschte Tresorinformationen mit erweiterten Details. |
| DeletedVaultProperties |
Eigenschaften des gelöschten Tresors. |
| DimensionProperties |
Typ des Vorgangs: Abrufen, Lesen, Löschen usw. |
| ErrorModel |
Der Serverfehler. |
| IPRule |
Eine Regel für die Barrierefreiheit eines Tresors aus einer bestimmten IP-Adresse oder einem bestimmten IP-Bereich. |
| Key |
Die Schlüsselressource. |
| KeyAttributes |
Die vom Azure Key Vault-Dienst verwalteten Objektattribute. |
| KeyCreateParameters |
Die Parameter, die zum Erstellen eines Schlüssels verwendet werden. |
| KeyProperties |
Die Eigenschaften des Schlüssels. |
| KeyReleasePolicy |
Modellschnittstelle KeyReleasePolicy |
| KeyRotationPolicyAttributes |
Modellschnittstelle KeyRotationPolicyAttributes |
| KeyVaultManagementClientOptionalParams |
Optionale Parameter für den Client. |
| KeysCreateIfNotExistOptionalParams |
Optionale Parameter. |
| KeysGetOptionalParams |
Optionale Parameter. |
| KeysGetVersionOptionalParams |
Optionale Parameter. |
| KeysListOptionalParams |
Optionale Parameter. |
| KeysListVersionsOptionalParams |
Optionale Parameter. |
| KeysOperations |
Schnittstelle stellt Keys-Operationen dar. |
| LifetimeAction |
Modell-Schnittstelle LifetimeAction |
| LogSpecification |
Protokollspezifikation des Vorgangs. |
| ManagedHSMSecurityDomainProperties |
Die Sicherheitsdomäneneigenschaften des verwalteten hsm. |
| ManagedHsm |
Ressourceninformationen mit erweiterten Details. |
| ManagedHsmAction |
Modellschnittstelle ManagedHsmAction |
| ManagedHsmError |
Die Fehler ausnahme. |
| ManagedHsmKey |
Die Schlüsselressource. |
| ManagedHsmKeyAttributes |
Die vom Azure Key Vault-Dienst verwalteten Objektattribute. |
| ManagedHsmKeyCreateParameters |
Die Parameter, die zum Erstellen eines Schlüssels verwendet werden. |
| ManagedHsmKeyProperties |
Die Eigenschaften des Schlüssels. |
| ManagedHsmKeyReleasePolicy |
Modellschnittstelle: ManagedHsmKeyReleasePolicy |
| ManagedHsmKeyRotationPolicyAttributes |
Modellschnittstelle ManagedHsmKeyRotationPolicyAttributes |
| ManagedHsmKeysCreateIfNotExistOptionalParams |
Optionale Parameter. |
| ManagedHsmKeysGetOptionalParams |
Optionale Parameter. |
| ManagedHsmKeysGetVersionOptionalParams |
Optionale Parameter. |
| ManagedHsmKeysListOptionalParams |
Optionale Parameter. |
| ManagedHsmKeysListVersionsOptionalParams |
Optionale Parameter. |
| ManagedHsmKeysOperations |
Schnittstelle stellt ManagedHsmKeys-Operationen dar. |
| ManagedHsmLifetimeAction |
Modellschnittstelle: ManagedHsmLifetimeAction |
| ManagedHsmProperties |
Eigenschaften des verwalteten HSM-Pools |
| ManagedHsmRotationPolicy |
Modellschnittstelle ManagedHsmRotationPolicy |
| ManagedHsmSku |
SKU-Details |
| ManagedHsmTrigger |
Modellschnittstelle ManagedHsmTrigger |
| ManagedHsmsCheckMhsmNameAvailabilityOptionalParams |
Optionale Parameter. |
| ManagedHsmsCreateOrUpdateOptionalParams |
Optionale Parameter. |
| ManagedHsmsDeleteOptionalParams |
Optionale Parameter. |
| ManagedHsmsGetDeletedOptionalParams |
Optionale Parameter. |
| ManagedHsmsGetOptionalParams |
Optionale Parameter. |
| ManagedHsmsListByResourceGroupOptionalParams |
Optionale Parameter. |
| ManagedHsmsListBySubscriptionOptionalParams |
Optionale Parameter. |
| ManagedHsmsListDeletedOptionalParams |
Optionale Parameter. |
| ManagedHsmsOperations |
Schnittstelle, die ManagedHsms-Operationen darstellt. |
| ManagedHsmsPurgeDeletedOptionalParams |
Optionale Parameter. |
| ManagedHsmsUpdateOptionalParams |
Optionale Parameter. |
| ManagedServiceIdentity |
Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten) |
| MetricSpecification |
Metrikspezifikation des Vorgangs. |
| MhsmGeoReplicatedRegion |
Eine Region, auf die dieser verwaltete HSM-Pool erweitert wurde. |
| MhsmNetworkRuleSet |
Eine Reihe von Regeln für die Netzwerkbarrierefreiheit eines verwalteten HSM-Pools. |
| MhsmPrivateEndpoint |
Eigenschaften des privaten Endpunktobjekts. |
| MhsmPrivateEndpointConnection |
Private Endpunktverbindungsressource. |
| MhsmPrivateEndpointConnectionItem |
Verbindungselement für private Endpunkte. |
| MhsmPrivateEndpointConnectionProperties |
Eigenschaften der privaten Endpunkt-Verbindungsressource. |
| MhsmPrivateEndpointConnectionsDeleteOptionalParams |
Optionale Parameter. |
| MhsmPrivateEndpointConnectionsGetOptionalParams |
Optionale Parameter. |
| MhsmPrivateEndpointConnectionsListByResourceOptionalParams |
Optionale Parameter. |
| MhsmPrivateEndpointConnectionsOperations |
Schnittstelle, die eine MhsmPrivateEndpointConnections-Operation darstellt. |
| MhsmPrivateEndpointConnectionsPutOptionalParams |
Optionale Parameter. |
| MhsmPrivateLinkResource |
Eine private Verknüpfungsressource |
| MhsmPrivateLinkResourceListResult |
Eine Liste der privaten Linkressourcen |
| MhsmPrivateLinkResourceProperties |
Eigenschaften einer privaten Verknüpfungsressource. |
| MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams |
Optionale Parameter. |
| MhsmPrivateLinkResourcesOperations |
Schnittstelle, die eine MhsmPrivateLinkResources-Operation darstellt. |
| MhsmPrivateLinkServiceConnectionState |
Ein Objekt, das den Genehmigungsstatus der privaten Verknüpfungsverbindung darstellt. |
| MhsmRegionsListByResourceOptionalParams |
Optionale Parameter. |
| MhsmRegionsOperations |
Schnittstelle, die eine MhsmRegions-Operation darstellt. |
| MhsmServiceTagRule |
Eine Regel, die die Zugänglichkeit eines verwalteten HSM-Pools von einem bestimmten Service-Tags regelt. |
| MhsmVirtualNetworkRule |
Eine Regel für die Barrierefreiheit eines verwalteten HSM-Pools aus einem bestimmten virtuellen Netzwerk. |
| MhsmipRule |
Eine Regel für die Barrierefreiheit eines verwalteten HSM-Pools aus einer bestimmten IP-Adresse oder einem bestimmten IP-Bereich. |
| NetworkRuleSet |
Eine Reihe von Regeln für die Netzwerkbarrierefreiheit eines Tresors. |
| Operation |
Definition des Schlüsseltresor-REST-API-Vorgangs. |
| OperationDisplay |
Zeigt Metadaten an, die dem Vorgang zugeordnet sind. |
| OperationProperties |
Betriebseigenschaften, einschließlich metrischer Spezifikationen. |
| OperationsListOptionalParams |
Optionale Parameter. |
| OperationsOperations |
Schnittstelle, die vorgänge darstellt. |
| PageSettings |
Optionen für die byPage-Methode |
| PagedAsyncIterableIterator |
Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht. |
| Permissions |
Berechtigungen, die die Identität für Schlüssel, geheime Schlüssel, Zertifikate und Speicher hat. |
| PrivateEndpoint |
Eigenschaften des privaten Endpunktobjekts. |
| PrivateEndpointConnection |
Private Endpunktverbindungsressource. |
| PrivateEndpointConnectionItem |
Verbindungselement für private Endpunkte. |
| PrivateEndpointConnectionProperties |
Eigenschaften der privaten Endpunkt-Verbindungsressource. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Optionale Parameter. |
| PrivateEndpointConnectionsGetOptionalParams |
Optionale Parameter. |
| PrivateEndpointConnectionsListByResourceOptionalParams |
Optionale Parameter. |
| PrivateEndpointConnectionsOperations |
Schnittstelle, die eine PrivateEndpointConnections-Vorgänge darstellt. |
| PrivateEndpointConnectionsPutOptionalParams |
Optionale Parameter. |
| PrivateLinkResource |
Eine private Verknüpfungsressource |
| PrivateLinkResourceListResult |
Eine Liste der privaten Linkressourcen |
| PrivateLinkResourceProperties |
Eigenschaften einer privaten Verknüpfungsressource. |
| PrivateLinkResourcesListByVaultOptionalParams |
Optionale Parameter. |
| PrivateLinkResourcesOperations |
Schnittstelle, die einen PrivateLinkResources-Vorgang darstellt. |
| PrivateLinkServiceConnectionState |
Ein Objekt, das den Genehmigungsstatus der privaten Verknüpfungsverbindung darstellt. |
| ProxyResource |
Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort. |
| Resource |
Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden |
| RestorePollerOptions | |
| RotationPolicy |
Model Interface RotationPolicy |
| Secret |
Ressourceninformationen mit erweiterten Details. |
| SecretAttributes |
Die Attribute der geheimen Verwaltung. |
| SecretCreateOrUpdateParameters |
Parameter zum Erstellen oder Aktualisieren eines geheimen Schlüssels |
| SecretPatchParameters |
Parameter zum Patchen eines geheimen Schlüssels |
| SecretPatchProperties |
Eigenschaften des geheimen Schlüssels |
| SecretProperties |
Eigenschaften des geheimen Schlüssels |
| SecretsCreateOrUpdateOptionalParams |
Optionale Parameter. |
| SecretsGetOptionalParams |
Optionale Parameter. |
| SecretsListOptionalParams |
Optionale Parameter. |
| SecretsOperations |
Schnittstelle stellt die Secrets-Operationen dar. |
| SecretsUpdateOptionalParams |
Optionale Parameter. |
| ServiceSpecification |
Eine Eigenschaft des Vorgangs, enthalten Protokollspezifikationen. |
| SimplePollerLike |
Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann. |
| Sku |
SKU-Details |
| SystemData |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
| TrackedResource |
Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort" |
| Trigger |
Modellschnittstelle Trigger |
| UserAssignedIdentity |
Benutzer zugewiesene Identitätseigenschaften |
| Vault |
Ressourceninformationen mit erweiterten Details. |
| VaultAccessPolicyParameters |
Parameter zum Aktualisieren der Zugriffsrichtlinie in einem Tresor |
| VaultAccessPolicyProperties |
Eigenschaften der Tresorzugriffsrichtlinie |
| VaultCheckNameAvailabilityParameters |
Die Parameter, die verwendet werden, um die Verfügbarkeit des Tresornamens zu überprüfen. |
| VaultCreateOrUpdateParameters |
Parameter zum Erstellen oder Aktualisieren eines Tresors |
| VaultPatchParameters |
Parameter zum Erstellen oder Aktualisieren eines Tresors |
| VaultPatchProperties |
Eigenschaften des Tresors |
| VaultProperties |
Eigenschaften des Tresors |
| VaultsCheckNameAvailabilityOptionalParams |
Optionale Parameter. |
| VaultsCreateOrUpdateOptionalParams |
Optionale Parameter. |
| VaultsDeleteOptionalParams |
Optionale Parameter. |
| VaultsGetDeletedOptionalParams |
Optionale Parameter. |
| VaultsGetOptionalParams |
Optionale Parameter. |
| VaultsListByResourceGroupOptionalParams |
Optionale Parameter. |
| VaultsListBySubscriptionOptionalParams |
Optionale Parameter. |
| VaultsListDeletedOptionalParams |
Optionale Parameter. |
| VaultsListOptionalParams |
Optionale Parameter. |
| VaultsOperations |
Schnittstelle, die einen Vaults-Vorgang darstellt. |
| VaultsPurgeDeletedOptionalParams |
Optionale Parameter. |
| VaultsUpdateAccessPolicyOptionalParams |
Optionale Parameter. |
| VaultsUpdateOptionalParams |
Optionale Parameter. |
| VirtualNetworkRule |
Eine Regel für die Barrierefreiheit eines Tresors aus einem bestimmten virtuellen Netzwerk. |
Typaliase
| AccessPolicyUpdateKind |
Art von AccessPolicyUpdateKind |
| ActionsRequired |
Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern. Bekannte Werte, die vom Dienst unterstützt werdenKeine |
| ActivationStatus |
Aktivierungsstatus Bekannte Werte, die vom Dienst unterstützt werden
Active: Der verwaltete HSM-Pool ist aktiv. |
| AzureSupportedClouds |
Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp |
| CertificatePermissions |
Art von Zertifikatsberechtigungen |
| ContinuablePage |
Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt. |
| CreateMode |
Der Erstellungsmodus des Tresors, um anzugeben, ob der Tresor wiederhergestellt werden muss oder nicht. |
| CreatedByType |
Die Art der Entität, die die Ressource erstellt hat. Bekannte Werte, die vom Dienst unterstützt werden
Benutzer-: Die Entität wurde von einem Benutzer erstellt. |
| DeletionRecoveryLevel |
Das aktuelle Wiederherstellungsniveau der Löschung gilt für das Objekt. Wenn es 'Purgeable' enthält, kann das Objekt von einem privilegierten Benutzer dauerhaft gelöscht werden; ansonsten kann nur das System das Objekt am Ende des Retentionsintervalls reinigen. Bekannte Werte, die vom Dienst unterstützt werden
bereinigungsfähige |
| GeoReplicationRegionProvisioningState |
Der aktuelle Bereitstellungsstatus. Bekannte Werte, die vom Dienst unterstützt werden
Voraberstellung |
| JsonWebKeyCurveName |
Der Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName. Standard für EC- und EC-HSM-Schlüssel ist P-256 Bekannte Werte, die vom Dienst unterstützt werden
P-256- |
| JsonWebKeyOperation |
Die erlaubten JSON-Webschlüsseloperationen des Schlüssels. Weitere Informationen finden Sie unter JsonWebKeyOperation. Bekannte Werte, die vom Dienst unterstützt werden
verschlüsseln |
| JsonWebKeyType |
Der Typ des Schlüssels. Gültige Werte finden Sie unter JsonWebKeyType. Bekannte Werte, die vom Dienst unterstützt werden
EC- |
| KeyPermissions |
Art von KeyPermissions |
| KeyRotationPolicyActionType |
Der Aktionstyp. |
| ManagedHsmSkuFamily |
SKU-Familie des verwalteten HSM-Pools Bekannte Werte, die vom Dienst unterstützt werden
B |
| ManagedHsmSkuName |
SKU des verwalteten HSM-Pools |
| ManagedServiceIdentityType |
Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). Bekannte Werte, die vom Dienst unterstützt werden
Keine: Keine verwaltete Identität. |
| NetworkRuleAction |
Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde. Bekannte Werte, die vom Dienst unterstützt werden
zulassen |
| NetworkRuleBypassOptions |
Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann 'AzureServices' oder 'None' sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices". Bekannte Werte, die vom Dienst unterstützt werden
AzureServices- |
| PrivateEndpointConnectionProvisioningState |
Der aktuelle Bereitstellungsstatus. Bekannte Werte, die vom Dienst unterstützt werden
erfolgreich |
| PrivateEndpointServiceConnectionStatus |
Der Status der privaten Endpunktverbindung. Bekannte Werte, die vom Dienst unterstützt werden
ausstehende |
| ProvisioningState |
Bereitstellungsstatus. Bekannte Werte, die vom Dienst unterstützt werden
erfolgreich: Der verwaltete HSM-Pool wurde vollständig bereitgestellt. |
| PublicNetworkAccess |
Steuern sie die Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken. Bekannte Werte, die vom Dienst unterstützt werden
Aktivierte |
| Reason |
Der Grund, warum ein Tresorname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable falsch ist. Bekannte Werte, die vom Dienst unterstützt werden
AccountNameInvalid |
| SecretPermissions |
Art von SecretPermissions |
| SkuFamily |
SKU-Familienname Bekannte Werte, die vom Dienst unterstützt werdenA |
| SkuName |
SKU-Name, um anzugeben, ob der Schlüsseltresor ein Standardtresor oder ein Premium Vault ist. |
| StoragePermissions |
Art von SpeicherBerechtigungen |
| VaultProvisioningState |
Bereitstellungsstatus des Tresors. Bekannte Werte, die vom Dienst unterstützt werden
erfolgreich |
Enumerationen
| AzureClouds |
Eine Enumeration zur Beschreibung von Azure Cloud-Umgebungen. |
| KnownActionsRequired |
Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern. |
| KnownActivationStatus |
Status der Aktivierung |
| KnownCertificatePermissions |
Bekannte Werte von CertificatePermissions, die der Dienst akzeptiert. |
| KnownCreatedByType |
Die Art der Entität, die die Ressource erstellt hat. |
| KnownDeletionRecoveryLevel |
Das aktuelle Wiederherstellungsniveau der Löschung gilt für das Objekt. Wenn es 'Purgeable' enthält, kann das Objekt von einem privilegierten Benutzer dauerhaft gelöscht werden; ansonsten kann nur das System das Objekt am Ende des Retentionsintervalls reinigen. |
| KnownGeoReplicationRegionProvisioningState |
Der aktuelle Bereitstellungsstatus. |
| KnownJsonWebKeyCurveName |
Der Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName. Standardeinstellung für EC- und EC-HSM-Schlüssel ist P-256 |
| KnownJsonWebKeyOperation |
Die erlaubten JSON-Webschlüsseloperationen des Schlüssels. Weitere Informationen finden Sie unter JsonWebKeyOperation. |
| KnownJsonWebKeyType |
Der Typ des Schlüssels. Gültige Werte finden Sie unter JsonWebKeyType. |
| KnownKeyPermissions |
Bekannte Werte von KeyPermissions, die der Dienst akzeptiert. |
| KnownManagedHsmSkuFamily |
SKU-Familie des verwalteten HSM-Pools |
| KnownManagedServiceIdentityType |
Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). |
| KnownNetworkRuleAction |
Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde. |
| KnownNetworkRuleBypassOptions |
Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann 'AzureServices' oder 'None' sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices". |
| KnownPrivateEndpointConnectionProvisioningState |
Der aktuelle Bereitstellungsstatus. |
| KnownPrivateEndpointServiceConnectionStatus |
Der Status der privaten Endpunktverbindung. |
| KnownProvisioningState |
Bereitstellungsstatus. |
| KnownPublicNetworkAccess |
Steuern sie die Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken. |
| KnownReason |
Der Grund, warum ein Tresorname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable falsch ist. |
| KnownSecretPermissions |
Bekannte Werte von SecretPermissions, die der Dienst akzeptiert. |
| KnownSkuFamily |
SKU-Familienname |
| KnownStoragePermissions |
Bekannte Werte von StoragePermissions, die der Dienst akzeptiert. |
| KnownVaultProvisioningState |
Bereitstellungsstatus des Tresors. |
| KnownVersions |
Die verfügbaren API-Versionen. |
Functions
| restore |
Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt. |
Details zur Funktion
restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.
function restorePoller<TResponse, TResult>(client: KeyVaultManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameter
- client
- KeyVaultManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Gibt zurück
PollerLike<OperationState<TResult>, TResult>