@azure/arm-keyvault package

Třídy

KeyVaultManagementClient

Rozhraní

AccessPolicyEntry	Identita, která má přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů.
Action	rozhraní modelu Akce
Attributes	Atributy objektu spravované službou KeyVault.
CheckMhsmNameAvailabilityParameters	Parametry použité ke kontrole dostupnosti názvu spravovaného hsm.
CheckMhsmNameAvailabilityResult	Odpověď operace CheckMhsmNameAvailability.
CheckNameAvailabilityResult	Odpověď operace CheckNameAvailability.
CloudError	Odpověď na chybu od poskytovatele prostředků služby Key Vault
CloudErrorBody	Odpověď na chybu od poskytovatele prostředků služby Key Vault
DeletedManagedHsm	Konkrétní typy prostředků proxy můžou být vytvořeny aliasem tohoto typu pomocí konkrétního typu vlastnosti.
DeletedManagedHsmProperties	Vlastnosti odstraněného spravovaného HSM
DeletedVault	Odstraněné informace o trezoru s rozšířenými podrobnostmi
DeletedVaultProperties	Vlastnosti odstraněného trezoru
DimensionProperties	Typ operace: get, read, delete atd.
ErrorModel	Chyba serveru.
IPRule	Pravidlo, které řídí přístupnost trezoru z konkrétní IP adresy nebo rozsahu IP adres.
Key	Klíčový prostředek.
KeyAttributes	Atributy objektu spravované službou Azure Key Vault.
KeyCreateParameters	Parametry použité k vytvoření klíče.
KeyProperties	Vlastnosti klíče.
KeyReleasePolicy	modelové rozhraní KeyReleasePolicy
KeyRotationPolicyAttributes	rozhraní modelu KeyRotationPolicyAttributes
KeyVaultManagementClientOptionalParams	Volitelné parametry pro klienta.
KeysCreateIfNotExistOptionalParams	Volitelné parametry.
KeysGetOptionalParams	Volitelné parametry.
KeysGetVersionOptionalParams	Volitelné parametry.
KeysListOptionalParams	Volitelné parametry.
KeysListVersionsOptionalParams	Volitelné parametry.
KeysOperations	Rozhraní reprezentující operace Klíče.
LifetimeAction	rozhraní modelu LifetimeAction
LogSpecification	Specifikace protokolu operace.
ManagedHSMSecurityDomainProperties	Vlastnosti domény zabezpečení spravovaného hsm.
ManagedHsm	Informace o zdroji s rozšířenými podrobnostmi
ManagedHsmAction	modelové rozhraní ManagedHsmAction
ManagedHsmError	Výjimka chyby.
ManagedHsmKey	Klíčový prostředek.
ManagedHsmKeyAttributes	Atributy objektu spravované službou Azure Key Vault.
ManagedHsmKeyCreateParameters	Parametry použité k vytvoření klíče.
ManagedHsmKeyProperties	Vlastnosti klíče.
ManagedHsmKeyReleasePolicy	modelové rozhraní ManagedHsmKeyReleasePolicy
ManagedHsmKeyRotationPolicyAttributes	modelové rozhraní ManagedHsmKeyRotationPolicyAttributes
ManagedHsmKeysCreateIfNotExistOptionalParams	Volitelné parametry.
ManagedHsmKeysGetOptionalParams	Volitelné parametry.
ManagedHsmKeysGetVersionOptionalParams	Volitelné parametry.
ManagedHsmKeysListOptionalParams	Volitelné parametry.
ManagedHsmKeysListVersionsOptionalParams	Volitelné parametry.
ManagedHsmKeysOperations	Rozhraní reprezentující operace ManagedHsmKeys.
ManagedHsmLifetimeAction	modelové rozhraní ManagedHsmLifetimeAction
ManagedHsmProperties	Vlastnosti spravovaného fondu HSM
ManagedHsmRotationPolicy	modelové rozhraní ManagedHsmRotationPolicy
ManagedHsmSku	Podrobnosti skladové položky
ManagedHsmTrigger	modelové rozhraní ManagedHsmTrigger
ManagedHsmsCheckMhsmNameAvailabilityOptionalParams	Volitelné parametry.
ManagedHsmsCreateOrUpdateOptionalParams	Volitelné parametry.
ManagedHsmsDeleteOptionalParams	Volitelné parametry.
ManagedHsmsGetDeletedOptionalParams	Volitelné parametry.
ManagedHsmsGetOptionalParams	Volitelné parametry.
ManagedHsmsListByResourceGroupOptionalParams	Volitelné parametry.
ManagedHsmsListBySubscriptionOptionalParams	Volitelné parametry.
ManagedHsmsListDeletedOptionalParams	Volitelné parametry.
ManagedHsmsOperations	Rozhraní reprezentující operace ManagedHsms.
ManagedHsmsPurgeDeletedOptionalParams	Volitelné parametry.
ManagedHsmsUpdateOptionalParams	Volitelné parametry.
ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
MetricSpecification	Specifikace operace metriky.
MhsmGeoReplicatedRegion	Oblast, na kterou byl tento spravovaný fond HSM rozšířen.
MhsmNetworkRuleSet	Sada pravidel, která řídí přístupnost sítě spravovaného fondu hsm.
MhsmPrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
MhsmPrivateEndpointConnection	Prostředek připojení privátního koncového bodu
MhsmPrivateEndpointConnectionItem	Položka připojení privátního koncového bodu
MhsmPrivateEndpointConnectionProperties	Vlastnosti zdroje připojení soukromého koncového zařízení.
MhsmPrivateEndpointConnectionsDeleteOptionalParams	Volitelné parametry.
MhsmPrivateEndpointConnectionsGetOptionalParams	Volitelné parametry.
MhsmPrivateEndpointConnectionsListByResourceOptionalParams	Volitelné parametry.
MhsmPrivateEndpointConnectionsOperations	Rozhraní reprezentující operace MhsmPrivateEndpointConnections.
MhsmPrivateEndpointConnectionsPutOptionalParams	Volitelné parametry.
MhsmPrivateLinkResource	Prostředek privátního propojení
MhsmPrivateLinkResourceListResult	Seznam prostředků privátního propojení
MhsmPrivateLinkResourceProperties	Vlastnosti prostředku privátního propojení
MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams	Volitelné parametry.
MhsmPrivateLinkResourcesOperations	Rozhraní reprezentující operace MhsmPrivateLinkResources.
MhsmPrivateLinkServiceConnectionState	Objekt, který představuje stav schválení připojení privátního propojení.
MhsmRegionsListByResourceOptionalParams	Volitelné parametry.
MhsmRegionsOperations	Rozhraní reprezentující operace MhsmRegions.
MhsmServiceTagRule	Pravidlo upravující dostupnost spravovaného HSM poolu z konkrétních servisních štítků.
MhsmVirtualNetworkRule	Pravidlo, které řídí přístupnost spravovaného fondu hsm z konkrétní virtuální sítě.
MhsmipRule	Pravidlo, které řídí přístupnost spravovaného fondu HSM z konkrétní IP adresy nebo rozsahu IP adres.
NetworkRuleSet	Sada pravidel, která řídí přístupnost sítě trezoru.
Operation	Definice operace rozhraní REST API služby Key Vault
OperationDisplay	Zobrazí metadata přidružená k operaci.
OperationProperties	Vlastnosti provozu, včetně metrických specifikací.
OperationsListOptionalParams	Volitelné parametry.
OperationsOperations	Rozhraní představující operace operací
PageSettings	Možnosti pro metodu byPage
PagedAsyncIterableIterator	Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.
Permissions	Oprávnění, která identita má pro klíče, tajné kódy, certifikáty a úložiště
PrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
PrivateEndpointConnection	Prostředek připojení privátního koncového bodu
PrivateEndpointConnectionItem	Položka připojení privátního koncového bodu
PrivateEndpointConnectionProperties	Vlastnosti zdroje připojení soukromého koncového zařízení.
PrivateEndpointConnectionsDeleteOptionalParams	Volitelné parametry.
PrivateEndpointConnectionsGetOptionalParams	Volitelné parametry.
PrivateEndpointConnectionsListByResourceOptionalParams	Volitelné parametry.
PrivateEndpointConnectionsOperations	Rozhraní představující PrivateEndpointConnections operace.
PrivateEndpointConnectionsPutOptionalParams	Volitelné parametry.
PrivateLinkResource	Prostředek privátního propojení
PrivateLinkResourceListResult	Seznam prostředků privátního propojení
PrivateLinkResourceProperties	Vlastnosti prostředku privátního propojení
PrivateLinkResourcesListByVaultOptionalParams	Volitelné parametry.
PrivateLinkResourcesOperations	Rozhraní představující operace PrivateLinkResources.
PrivateLinkServiceConnectionState	Objekt, který představuje stav schválení připojení privátního propojení.
ProxyResource	Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění.
Resource	Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru
RestorePollerOptions
RotationPolicy	Rozhraní modelu RotationPolicy
Secret	Informace o zdroji s rozšířenými podrobnostmi
SecretAttributes	Atributy správy tajných kódů.
SecretCreateOrUpdateParameters	Parametry pro vytvoření nebo aktualizaci tajného kódu
SecretPatchParameters	Parametry pro opravy tajného kódu
SecretPatchProperties	Vlastnosti tajného klíče
SecretProperties	Vlastnosti tajného klíče
SecretsCreateOrUpdateOptionalParams	Volitelné parametry.
SecretsGetOptionalParams	Volitelné parametry.
SecretsListOptionalParams	Volitelné parametry.
SecretsOperations	Rozhraní reprezentující operace Secrets.
SecretsUpdateOptionalParams	Volitelné parametry.
ServiceSpecification	Jedna vlastnost operace, včetně specifikací protokolu.
SimplePollerLike	Jednoduchý poller, který lze použít k dotazování dlouhotrvající operace.
Sku	Podrobnosti skladové položky
SystemData	Metadata týkající se vytvoření a poslední změny prostředku.
TrackedResource	Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění.
Trigger	Spouštěč rozhraní modelu
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem
Vault	Informace o zdroji s rozšířenými podrobnostmi
VaultAccessPolicyParameters	Parametry pro aktualizaci zásad přístupu v trezoru
VaultAccessPolicyProperties	Vlastnosti zásad přístupu trezoru
VaultCheckNameAvailabilityParameters	Parametry použité ke kontrole dostupnosti názvu trezoru.
VaultCreateOrUpdateParameters	Parametry pro vytvoření nebo aktualizaci trezoru
VaultPatchParameters	Parametry pro vytvoření nebo aktualizaci trezoru
VaultPatchProperties	Vlastnosti trezoru
VaultProperties	Vlastnosti trezoru
VaultsCheckNameAvailabilityOptionalParams	Volitelné parametry.
VaultsCreateOrUpdateOptionalParams	Volitelné parametry.
VaultsDeleteOptionalParams	Volitelné parametry.
VaultsGetDeletedOptionalParams	Volitelné parametry.
VaultsGetOptionalParams	Volitelné parametry.
VaultsListByResourceGroupOptionalParams	Volitelné parametry.
VaultsListBySubscriptionOptionalParams	Volitelné parametry.
VaultsListDeletedOptionalParams	Volitelné parametry.
VaultsListOptionalParams	Volitelné parametry.
VaultsOperations	Rozhraní představující operace Vaults.
VaultsPurgeDeletedOptionalParams	Volitelné parametry.
VaultsUpdateAccessPolicyOptionalParams	Volitelné parametry.
VaultsUpdateOptionalParams	Volitelné parametry.
VirtualNetworkRule	Pravidlo, které řídí přístupnost trezoru z konkrétní virtuální sítě.

Aliasy typu

AccessPolicyUpdateKind	Typ AccessPolicyUpdateKind
ActionsRequired	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce. PoleActionsRequired lze použít zaměnitelně s ActionsRequired, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Žádné
ActivationStatus	Stav aktivace PoleActivationStatus lze použít zaměnitelně s ActivationStatus, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou aktivní: Spravovaný fond HSM je aktivní. NotActivated: Spravovaný fond HSM ještě není aktivovaný. Neznámý: Při aktivaci spravovaného hsmu došlo k neznámé chybě. selhání: Nepodařilo se aktivovat spravované hsm.
AzureSupportedClouds	Podporované hodnoty pro nastavení cloudu jako typ řetězcového literálu
CertificatePermissions	Typ certifikátuOprávnění
ContinuablePage	Rozhraní, které popisuje stránku výsledků.
CreateMode	Režim vytvoření trezoru označující, jestli se má trezor obnovit, nebo ne.
CreatedByType	Druh entity, která prostředek vytvořila. PoleCreatedByType lze použít zaměnitelně s CreatedByType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou user: Entita byla vytvořena uživatelem. Application: Entita byla vytvořena aplikací. ManagedIdentity: Entita byla vytvořena spravovanou identitou. Klíč: Entita byla vytvořena klíčem.
DeletionRecoveryLevel	Úroveň obnovy po odstranění je aktuálně platná pro objekt. Pokud obsahuje 'Purgeable', může být objekt trvale smazán privilegovaným uživatelem; jinak může objekt vyčistit pouze systém na konci retenčního intervalu. PoleDeletionRecoveryLevel lze použít zaměnitelně s DeletionRecoveryLevel, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou purgeable obnovitelné a vyprázdnitelné obnovitelné obnovitelné a chráněné podsítě
GeoReplicationRegionProvisioningState	Aktuální stav zřizování. PoleGeoReplicationRegionProvisioningState lze použít zaměnitelně s GeoReplicationRegionProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou předběžného zřízení zřizování úspěšné selhalo odstranění vyčištění
JsonWebKeyCurveName	Název tři tečky. Platné hodnoty najdete v tématu JsonWebKeyCurveName. Výchozí pro EC a EC-HSM klíče je P-256 PoleJsonWebKeyCurveName lze použít zaměnitelně s JsonWebKeyCurveName, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou P-256 P-384 P-521 P-256K
JsonWebKeyOperation	Povolil operace s webovým klíčem JSON pro klíč. Další informace najdete v tématu JsonWebKeyOperation. PoleJsonWebKeyOperation lze použít zaměnitelně s JsonWebKeyOperation, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou šifrování dešifrování znaménko ověření wrapKey rozbalení klíče importu vydané verze
JsonWebKeyType	Typ klíče. Platné hodnoty najdete v tématu JsonWebKeyType. PoleJsonWebKeyType lze použít zaměnitelně s JsonWebKeyType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou EC EC-HSM RSA RSA-HSM
KeyPermissions	Typ KeyPermissions
KeyRotationPolicyActionType	Typ akce.
ManagedHsmSkuFamily	SKU Family spravovaného HSM Poolu PoleManagedHsmSkuFamily lze použít zaměnitelně s ManagedHsmSkuFamily, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou B C
ManagedHsmSkuName	Skladová položka spravovaného fondu HSM
ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned). PoleManagedServiceIdentityType lze použít zaměnitelně s ManagedServiceIdentityType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Žádná: Žádná spravovaná identita. SystemAssigned: Spravovaná identita přiřazená systémem. UserAssigned: Spravovaná identita přiřazená uživatelem. SystemAssigned, UserAssigned: Spravovaná identita přiřazená systémem a uživatelem.
NetworkRuleAction	Výchozí akce, pokud se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Tento parametr se použije až po vyhodnocení vlastnosti bypass. PoleNetworkRuleAction lze použít zaměnitelně s NetworkRuleAction, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Povolit Odepřít
NetworkRuleBypassOptions	Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud nezadáte výchozí hodnotu AzureServices. PoleNetworkRuleBypassOptions lze použít zaměnitelně s NetworkRuleBypassOptions, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou azureServices Žádné
PrivateEndpointConnectionProvisioningState	Aktuální stav zřizování. PolePrivateEndpointConnectionProvisioningState lze použít zaměnitelně s PrivateEndpointConnectionProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou úspěšné vytváření Aktualizace odstranění selhalo odpojené
PrivateEndpointServiceConnectionStatus	Stav připojení privátního koncového bodu. KnownPrivateEndpointServiceConnectionStatus lze použít zaměnitelně s PrivateEndpointServiceConnectionStatus, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou čekající schválené odmítnuté odpojené
ProvisioningState	Stav zřizování KnownProvisioningState lze použít zaměnitelně s ProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou úspěšné: Spravovaný fond HSM byl plně zřízený. zřizování: Spravovaný fond HSM se právě zřizuje. selhalo: Zřizování spravovaného fondu HSM se nezdařilo. aktualizace: Právě probíhá aktualizace spravovaného fondu HSM. Odstranění: Spravovaný fond HSM se právě odstraňuje. Aktivovaný: Spravovaný fond HSM je připravený k normálnímu použití. SecurityDomainRestore: Spravovaný fond HSM čeká na akci obnovení domény zabezpečení. Obnovení: Spravovaný fond HSM se obnovuje z úplného zálohování HSM.
PublicNetworkAccess	Řízení oprávnění ke spravovanému HSM z veřejných sítí KnownPublicNetworkAccess lze použít zaměnitelně s PublicNetworkAccess, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Povoleno Zakázáno
Reason	Důvod, proč název trezoru nemohl být použit. Prvek Reason je vrácen pouze v případě, že NameAvailable je false. KnowReason lze používat zaměnitelně s Reason, toto enum obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou AccountNameInvalid AlreadyExists
SecretPermissions	Typ SecretPermissions
SkuFamily	Příjmení SKU PoleSkuFamily lze použít zaměnitelně s SkuFamily, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou A
SkuName	Název skladové položky pro určení, jestli je trezor klíčů standardním trezorem nebo trezorem úrovně Premium.
StoragePermissions	Typ oprávnění k ukládání dat
VaultProvisioningState	Stav zřizování trezoru PoleVaultProvisioningState lze použít zaměnitelně s VaultProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou úspěšné registeringDns

Výčty

AzureClouds	Výčet popisující cloudová prostředí Azure.
KnownActionsRequired	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
KnownActivationStatus	Stav aktivace
KnownCertificatePermissions	Známé hodnoty CertificatePermissions, které služba přijímá.
KnownCreatedByType	Druh entity, která prostředek vytvořila.
KnownDeletionRecoveryLevel	Úroveň obnovy po odstranění je aktuálně platná pro objekt. Pokud obsahuje 'Purgeable', může být objekt trvale smazán privilegovaným uživatelem; jinak může objekt vyčistit pouze systém na konci retenčního intervalu.
KnownGeoReplicationRegionProvisioningState	Aktuální stav zřizování.
KnownJsonWebKeyCurveName	Název tři tečky. Platné hodnoty najdete v tématu JsonWebKeyCurveName. Výchozí hodnota pro klíče EC a EC-HSM je P-256.
KnownJsonWebKeyOperation	Povolil operace s webovým klíčem JSON pro klíč. Další informace najdete v tématu JsonWebKeyOperation.
KnownJsonWebKeyType	Typ klíče. Platné hodnoty najdete v tématu JsonWebKeyType.
KnownKeyPermissions	Známé hodnoty KeyPermissions, které služba přijímá.
KnownManagedHsmSkuFamily	Řada skladových položek spravovaného fondu HSM
KnownManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
KnownNetworkRuleAction	Výchozí akce, pokud se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Tento parametr se použije až po vyhodnocení vlastnosti bypass.
KnownNetworkRuleBypassOptions	Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud nezadáte výchozí hodnotu AzureServices.
KnownPrivateEndpointConnectionProvisioningState	Aktuální stav zřizování.
KnownPrivateEndpointServiceConnectionStatus	Stav připojení privátního koncového bodu.
KnownProvisioningState	Stav zřizování
KnownPublicNetworkAccess	Řízení oprávnění ke spravovanému HSM z veřejných sítí
KnownReason	Důvod, proč název trezoru nemohl být použit. Prvek Reason je vrácen pouze v případě, že NameAvailable je false.
KnownSecretPermissions	Známé hodnoty SecretPermissions, které služba přijímá.
KnownSkuFamily	Jméno rodiny skladové položky
KnownStoragePermissions	Známé hodnoty StoragePermissions, které služba přijímá.
KnownVaultProvisioningState	Stav zřizování trezoru
KnownVersions	Dostupné verze rozhraní API.

Funkce

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

Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.

Podrobnosti funkce

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

Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.

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

Parametry

client

KeyVaultManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Návraty

PollerLike<OperationState<TResult>, TResult>