@azure/arm-keyvault package

Klasser

KeyVaultManagementClient

Gränssnitt

AccessPolicyEntry	En identitet som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klient-ID som nyckelvalvets klient-ID.
Action	Modellgränssnitt Handling
Attributes	Objektattributen som hanteras av KeyVault-tjänsten.
CheckMhsmNameAvailabilityParameters	De parametrar som används för att kontrollera tillgängligheten för det hanterade hsm-namnet.
CheckMhsmNameAvailabilityResult	Åtgärdssvaret CheckMhsmNameAvailability.
CheckNameAvailabilityResult	Åtgärdssvaret CheckNameAvailability.
CloudError	Ett felsvar från Key Vault-resursprovidern
CloudErrorBody	Ett felsvar från Key Vault-resursprovidern
DeletedManagedHsm	Konkreta proxyresurstyper kan skapas genom att aliasisera den här typen med hjälp av en specifik egenskapstyp.
DeletedManagedHsmProperties	Egenskaper för den borttagna hanterade HSM:en.
DeletedVault	Borttagen valvinformation med utökad information.
DeletedVaultProperties	Egenskaper för det borttagna valvet.
DimensionProperties	Typ av åtgärd: hämta, läsa, ta bort osv.
ErrorModel	Serverfelet.
IPRule	En regel som styr tillgängligheten för ett valv från en specifik IP-adress eller ett ip-intervall.
Key	Nyckelresursen.
KeyAttributes	Objektattributen som hanteras av Azure Key Vault-tjänsten.
KeyCreateParameters	Parametrarna som används för att skapa en nyckel.
KeyProperties	Egenskaperna för nyckeln.
KeyReleasePolicy	modellgränssnitt KeyReleasePolicy
KeyRotationPolicyAttributes	modellgränssnitt KeyRotationPolicyAttributes
KeyVaultManagementClientOptionalParams	Valfria parametrar för klienten.
KeysCreateIfNotExistOptionalParams	Valfria parametrar.
KeysGetOptionalParams	Valfria parametrar.
KeysGetVersionOptionalParams	Valfria parametrar.
KeysListOptionalParams	Valfria parametrar.
KeysListVersionsOptionalParams	Valfria parametrar.
KeysOperations	Gränssnitt som representerar Keys-operationer.
LifetimeAction	modellgränssnittet LifetimeAction
LogSpecification	Loggspecifikation för drift.
ManagedHSMSecurityDomainProperties	Säkerhetsdomänegenskaperna för den hanterade hsm.
ManagedHsm	Resursinformation med utökad information.
ManagedHsmAction	modellgränssnitt ManagedHsmAction
ManagedHsmError	Felfelsfelet.
ManagedHsmKey	Nyckelresursen.
ManagedHsmKeyAttributes	Objektattributen som hanteras av Azure Key Vault-tjänsten.
ManagedHsmKeyCreateParameters	Parametrarna som används för att skapa en nyckel.
ManagedHsmKeyProperties	Egenskaperna för nyckeln.
ManagedHsmKeyReleasePolicy	modellgränssnitt ManagedHsmKeyReleasePolicy
ManagedHsmKeyRotationPolicyAttributes	modellgränssnitt ManagedHsmKeyRotationPolicyAttributes
ManagedHsmKeysCreateIfNotExistOptionalParams	Valfria parametrar.
ManagedHsmKeysGetOptionalParams	Valfria parametrar.
ManagedHsmKeysGetVersionOptionalParams	Valfria parametrar.
ManagedHsmKeysListOptionalParams	Valfria parametrar.
ManagedHsmKeysListVersionsOptionalParams	Valfria parametrar.
ManagedHsmKeysOperations	Gränssnitt som representerar ManagedHsmKeys-operationer.
ManagedHsmLifetimeAction	modellgränssnitt ManagedHsmLifetimeAction
ManagedHsmProperties	Egenskaper för den hanterade HSM-poolen
ManagedHsmRotationPolicy	modellgränssnitt ManagedHsmRotationPolicy
ManagedHsmSku	SKU-information
ManagedHsmTrigger	modellgränssnitt ManagedHsmTrigger
ManagedHsmsCheckMhsmNameAvailabilityOptionalParams	Valfria parametrar.
ManagedHsmsCreateOrUpdateOptionalParams	Valfria parametrar.
ManagedHsmsDeleteOptionalParams	Valfria parametrar.
ManagedHsmsGetDeletedOptionalParams	Valfria parametrar.
ManagedHsmsGetOptionalParams	Valfria parametrar.
ManagedHsmsListByResourceGroupOptionalParams	Valfria parametrar.
ManagedHsmsListBySubscriptionOptionalParams	Valfria parametrar.
ManagedHsmsListDeletedOptionalParams	Valfria parametrar.
ManagedHsmsOperations	Gränssnitt som representerar en ManagedHsms-operation.
ManagedHsmsPurgeDeletedOptionalParams	Valfria parametrar.
ManagedHsmsUpdateOptionalParams	Valfria parametrar.
ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
MetricSpecification	Måttspecifikation för drift.
MhsmGeoReplicatedRegion	En region som den här hanterade HSM-poolen har utökats till.
MhsmNetworkRuleSet	En uppsättning regler som styr nätverkstillgängligheten för en hanterad hsm-pool.
MhsmPrivateEndpoint	Egenskaper för privat slutpunktsobjekt.
MhsmPrivateEndpointConnection	Privat slutpunktsanslutningsresurs.
MhsmPrivateEndpointConnectionItem	Privat slutpunktsanslutningsobjekt.
MhsmPrivateEndpointConnectionProperties	Egenskaper hos den privata slutpunktsanslutningsresursen.
MhsmPrivateEndpointConnectionsDeleteOptionalParams	Valfria parametrar.
MhsmPrivateEndpointConnectionsGetOptionalParams	Valfria parametrar.
MhsmPrivateEndpointConnectionsListByResourceOptionalParams	Valfria parametrar.
MhsmPrivateEndpointConnectionsOperations	Gränssnitt som representerar en MhsmPrivateEndpointConnections-operation.
MhsmPrivateEndpointConnectionsPutOptionalParams	Valfria parametrar.
MhsmPrivateLinkResource	En privat länkresurs
MhsmPrivateLinkResourceListResult	En lista över privata länkresurser
MhsmPrivateLinkResourceProperties	Egenskaper för en privat länkresurs.
MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams	Valfria parametrar.
MhsmPrivateLinkResourcesOperations	Gränssnitt som representerar en MhsmPrivateLinkResources-operation.
MhsmPrivateLinkServiceConnectionState	Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.
MhsmRegionsListByResourceOptionalParams	Valfria parametrar.
MhsmRegionsOperations	Gränssnitt som representerar MhsmRegions-operationer.
MhsmServiceTagRule	En regel som styr tillgängligheten till en hanterad hsm-pool från specifika servicetaggar.
MhsmVirtualNetworkRule	En regel som styr tillgängligheten för en hanterad hsm-pool från ett specifikt virtuellt nätverk.
MhsmipRule	En regel som styr tillgängligheten för en hanterad HSM-pool från en specifik IP-adress eller ETT IP-intervall.
NetworkRuleSet	En uppsättning regler som styr nätverkstillgängligheten för ett valv.
Operation	Key Vault REST API-åtgärdsdefinition.
OperationDisplay	Visa metadata som är associerade med åtgärden.
OperationProperties	Egenskaper för operationen, inklusive metriska specifikationer.
OperationsListOptionalParams	Valfria parametrar.
OperationsOperations	Gränssnitt som representerar åtgärder.
PageSettings	Alternativ för byPage-metoden
PagedAsyncIterableIterator	Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.
Permissions	Behörigheter som identiteten har för nycklar, hemligheter, certifikat och lagring.
PrivateEndpoint	Egenskaper för privat slutpunktsobjekt.
PrivateEndpointConnection	Privat slutpunktsanslutningsresurs.
PrivateEndpointConnectionItem	Privat slutpunktsanslutningsobjekt.
PrivateEndpointConnectionProperties	Egenskaper hos den privata slutpunktsanslutningsresursen.
PrivateEndpointConnectionsDeleteOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsGetOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsListByResourceOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsOperations	Gränssnitt som representerar en PrivateEndpointConnections-åtgärder.
PrivateEndpointConnectionsPutOptionalParams	Valfria parametrar.
PrivateLinkResource	En privat länkresurs
PrivateLinkResourceListResult	En lista över privata länkresurser
PrivateLinkResourceProperties	Egenskaper för en privat länkresurs.
PrivateLinkResourcesListByVaultOptionalParams	Valfria parametrar.
PrivateLinkResourcesOperations	Gränssnitt som representerar en PrivateLinkResources-åtgärd.
PrivateLinkServiceConnectionState	Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.
ProxyResource	Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats
Resource	Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser
RestorePollerOptions
RotationPolicy	modellgränssnitt RotationPolicy
Secret	Resursinformation med utökad information.
SecretAttributes	De hemliga hanteringsattributen.
SecretCreateOrUpdateParameters	Parametrar för att skapa eller uppdatera en hemlighet
SecretPatchParameters	Parametrar för att korrigera en hemlighet
SecretPatchProperties	Egenskaper för hemligheten
SecretProperties	Egenskaper för hemligheten
SecretsCreateOrUpdateOptionalParams	Valfria parametrar.
SecretsGetOptionalParams	Valfria parametrar.
SecretsListOptionalParams	Valfria parametrar.
SecretsOperations	Gränssnitt som representerar en Secrets-operation.
SecretsUpdateOptionalParams	Valfria parametrar.
ServiceSpecification	En egenskap för åtgärden, inkluderar loggspecifikationer.
SimplePollerLike	En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd.
Sku	SKU-information
SystemData	Metadata som rör skapande och senaste ändring av resursen.
TrackedResource	Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"
Trigger	modellgränssnitt Trigger
UserAssignedIdentity	Användartilldelade identitetsegenskaper
Vault	Resursinformation med utökad information.
VaultAccessPolicyParameters	Parametrar för uppdatering av åtkomstprincipen i ett valv
VaultAccessPolicyProperties	Egenskaper för principen för valvåtkomst
VaultCheckNameAvailabilityParameters	De parametrar som används för att kontrollera valvnamnets tillgänglighet.
VaultCreateOrUpdateParameters	Parametrar för att skapa eller uppdatera ett valv
VaultPatchParameters	Parametrar för att skapa eller uppdatera ett valv
VaultPatchProperties	Egenskaper för valvet
VaultProperties	Egenskaper för valvet
VaultsCheckNameAvailabilityOptionalParams	Valfria parametrar.
VaultsCreateOrUpdateOptionalParams	Valfria parametrar.
VaultsDeleteOptionalParams	Valfria parametrar.
VaultsGetDeletedOptionalParams	Valfria parametrar.
VaultsGetOptionalParams	Valfria parametrar.
VaultsListByResourceGroupOptionalParams	Valfria parametrar.
VaultsListBySubscriptionOptionalParams	Valfria parametrar.
VaultsListDeletedOptionalParams	Valfria parametrar.
VaultsListOptionalParams	Valfria parametrar.
VaultsOperations	Gränssnitt som representerar en Vaults-åtgärd.
VaultsPurgeDeletedOptionalParams	Valfria parametrar.
VaultsUpdateAccessPolicyOptionalParams	Valfria parametrar.
VaultsUpdateOptionalParams	Valfria parametrar.
VirtualNetworkRule	En regel som styr tillgängligheten för ett valv från ett specifikt virtuellt nätverk.

Typalias

AccessPolicyUpdateKind	Typ av AccessPolicyUpdateKind
ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten. KnownActionsRequired kan användas omväxlande med ActionsRequired innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Ingen
ActivationStatus	Aktiveringsstatus KnownActivationStatus kan användas omväxlande med ActivationStatus innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Aktiv: Den hanterade HSM-poolen är aktiv. NotActivated: Den hanterade HSM-poolen har ännu inte aktiverats. Okänd: Ett okänt fel inträffade när hanterad hsm aktiverades. Misslyckades: Det gick inte att aktivera hanterad hsm.
AzureSupportedClouds	De värden som stöds för molninställningen som en strängliteraltyp
CertificatePermissions	Typ av certifikatBehörigheter
ContinuablePage	Ett gränssnitt som beskriver en resultatsida.
CreateMode	Valvets skapandeläge för att ange om valvet behöver återställas eller inte.
CreatedByType	Den typ av entitet som skapade resursen. KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Användare: Entiteten skapades av en användare. Application: Entiteten skapades av ett program. ManagedIdentity: Entiteten skapades av en hanterad identitet. Nyckel: Entiteten skapades av en nyckel.
DeletionRecoveryLevel	Återställningsnivån för radering gäller för objektet. Om den innehåller 'Purgeable' kan objektet permanent raderas av en privilegierad användare; annars kan endast systemet rensa objektet i slutet av retentionsintervallet. KnownDeletionRecoveryLevel kan användas omväxlande med DeletionRecoveryLevel innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Rensningsbar Återställningsbar+ rensningsbar återställningsbar Recoverable+ProtectedSubscription
GeoReplicationRegionProvisioningState	Det aktuella etableringstillståndet. KnownGeoReplicationRegionProvisioningState kan användas omväxlande med GeoReplicationRegionProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Företablering Etablering lyckades misslyckades ta bort Rensa
JsonWebKeyCurveName	Det elliptiska kurvnamnet. Giltiga värden finns i JsonWebKeyCurveName. Standard för EC- och EC-HSM-tangenter är P-256 KnownJsonWebKeyCurveName kan användas utbytbart med JsonWebKeyCurveName innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten P-256 P-384 P-521 P-256K
JsonWebKeyOperation	De tillåtna JSON-webbnyckeloperationerna för nyckeln. Mer information finns i JsonWebKeyOperation. KnownJsonWebKeyOperation kan användas utbytbart med JsonWebKeyOperation innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten kryptera dekryptera signera verifiera wrapKey importera release
JsonWebKeyType	Typ av nyckel. Giltiga värden finns i JsonWebKeyType. KnownJsonWebKeyType kan användas utbytbart med JsonWebKeyType innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten EG- EC-HSM RSA RSA-HSM
KeyPermissions	Typ av KeyPermissions
KeyRotationPolicyActionType	Typ av åtgärd.
ManagedHsmSkuFamily	SKU-familjen för den hanterade HSM-poolen KnownManagedHsmSkuFamily kan användas omväxlande med ManagedHsmSkuFamily innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten B C
ManagedHsmSkuName	SKU för den hanterade HSM-poolen
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). KnownManagedServiceIdentityType kan användas utbytbart med ManagedServiceIdentityType innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Ingen: Ingen hanterad identitet. SystemAssigned: Systemtilldelad hanterad identitet. UserAssigned: Användartilldelad hanterad identitet. SystemAssigned, UserAssigned: System och användartilldelad hanterad identitet.
NetworkRuleAction	Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats. KnownNetworkRuleAction kan användas omväxlande med NetworkRuleAction innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Tillåt Neka
NetworkRuleBypassOptions	Talar om för vilken trafik som kan kringgå nätverksregler. Det kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices". KnownNetworkRuleBypassOptions kan användas utbytbart med NetworkRuleBypassOptions innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten AzureServices Ingen
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet. KnownPrivateEndpointConnectionProvisioningState kan användas utbytbart med PrivateEndpointConnectionProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten lyckades Skapa uppdaterar ta bort misslyckades frånkopplad
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt. KnownPrivateEndpointServiceConnectionStatus kan användas utbytbart med PrivateEndpointServiceConnectionStatus innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten väntar på Godkänd avvisade frånkopplad
ProvisioningState	Etableringstillstånd. KnownProvisioningState kan användas omväxlande med ProvisioningState innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Lyckades: Den hanterade HSM-poolen har etablerats fullt ut. Etablering: Den hanterade HSM-poolen etableras för närvarande. Misslyckades: Etableringen av den hanterade HSM-poolen misslyckades. Uppdaterar: Den hanterade HSM-poolen uppdateras för närvarande. Tar bort: Den hanterade HSM-poolen tas för närvarande bort. Aktiverad: Den hanterade HSM-poolen är redo för normal användning. SecurityDomainRestore: Den hanterade HSM-poolen väntar på en återställningsåtgärd för säkerhetsdomäner. Återställa: Den hanterade HSM-poolen återställs från fullständig HSM-säkerhetskopiering.
PublicNetworkAccess	Kontrollera behörigheten till den hanterade HSM:en från offentliga nätverk. KnownPublicNetworkAccess kan användas utbytbart med PublicNetworkAccess innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten aktiverat inaktiverad
Reason	Anledningen till att ett valvnamn inte kunde användas. Reason-elementet returneras endast om NameAvailable är falskt. KnownReason kan användas omväxlande med Reason, detta enum innehåller de kända värden som tjänsten stödjer. Kända värden som stöds av tjänsten KontoNamnOgiltig Finns redan
SecretPermissions	Typ av SecretPermissions
SkuFamily	SKU-efternamnet KnownSkuFamily kan användas utbytbart med SkuFamily innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten A
SkuName	SKU-namn för att ange om nyckelvalvet är ett standardvalv eller ett Premium-valv.
StoragePermissions	Typ av lagringsbehörigheter
VaultProvisioningState	Etableringstillstånd för valvet. KnownVaultProvisioningState kan användas utbytbart med VaultProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten lyckades RegisteringDns

Uppräkningar

AzureClouds	En uppräkning för att beskriva Azure Cloud-miljöer.
KnownActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
KnownActivationStatus	Status för aktivering
KnownCertificatePermissions	Kända värden för CertificatePermissions som tjänsten accepterar.
KnownCreatedByType	Den typ av entitet som skapade resursen.
KnownDeletionRecoveryLevel	Återställningsnivån för radering gäller för objektet. Om den innehåller 'Purgeable' kan objektet permanent raderas av en privilegierad användare; annars kan endast systemet rensa objektet i slutet av retentionsintervallet.
KnownGeoReplicationRegionProvisioningState	Det aktuella etableringstillståndet.
KnownJsonWebKeyCurveName	Det elliptiska kurvnamnet. Giltiga värden finns i JsonWebKeyCurveName. Standardvärdet för EC- och EC-HSM nycklar är P-256
KnownJsonWebKeyOperation	De tillåtna JSON-webbnyckeloperationerna för nyckeln. Mer information finns i JsonWebKeyOperation.
KnownJsonWebKeyType	Typ av nyckel. Giltiga värden finns i JsonWebKeyType.
KnownKeyPermissions	Kända värden för KeyPermissions som tjänsten accepterar.
KnownManagedHsmSkuFamily	SKU-familj för den hanterade HSM-poolen
KnownManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
KnownNetworkRuleAction	Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats.
KnownNetworkRuleBypassOptions	Talar om för vilken trafik som kan kringgå nätverksregler. Det kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".
KnownPrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet.
KnownPrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
KnownProvisioningState	Etableringstillstånd.
KnownPublicNetworkAccess	Kontrollera behörigheten till den hanterade HSM:en från offentliga nätverk.
KnownReason	Anledningen till att ett valvnamn inte kunde användas. Reason-elementet returneras endast om NameAvailable är falskt.
KnownSecretPermissions	Kända värden för SecretPermissions som tjänsten accepterar.
KnownSkuFamily	SKU-familjenamn
KnownStoragePermissions	Kända värden för StoragePermissions som tjänsten accepterar.
KnownVaultProvisioningState	Etableringstillstånd för valvet.
KnownVersions	Tillgängliga API-versioner.

Funktioner

restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

Funktionsinformation

restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

function restorePoller<TResponse, TResult>(client: KeyVaultManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parametrar

client

KeyVaultManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returer

PollerLike<OperationState<TResult>, TResult>