@azure/arm-keyvault package
Klassen
| KeyVaultManagementClient |
Interfaces
| AccessPolicyEntry |
Een identiteit die toegang heeft tot de sleutelkluis. Alle identiteiten in de matrix moeten dezelfde tenant-id gebruiken als de tenant-id van de sleutelkluis. |
| Action |
modelinterface Actie |
| Attributes |
De objectkenmerken die worden beheerd door de KeyVault-service. |
| CheckMhsmNameAvailabilityParameters |
De parameters die worden gebruikt om de beschikbaarheid van de beheerde hsm-naam te controleren. |
| CheckMhsmNameAvailabilityResult |
Het antwoord van de checkMhsmNameAvailability-bewerking. |
| CheckNameAvailabilityResult |
Het antwoord van de bewerking CheckNameAvailability. |
| CloudError |
Een foutreactie van de Key Vault-resourceprovider |
| CloudErrorBody |
Een foutreactie van de Key Vault-resourceprovider |
| DeletedManagedHsm |
Concrete proxyresourcetypen kunnen worden gemaakt door dit type te aliasen met behulp van een specifiek eigenschapstype. |
| DeletedManagedHsmProperties |
Eigenschappen van de verwijderde beheerde HSM. |
| DeletedVault |
Verwijderde kluisgegevens met uitgebreide details. |
| DeletedVaultProperties |
Eigenschappen van de verwijderde kluis. |
| DimensionProperties |
Type bewerking: ophalen, lezen, verwijderen, enzovoort. |
| ErrorModel |
De serverfout. |
| IPRule |
Een regel voor de toegankelijkheid van een kluis vanuit een specifiek IP-adres of IP-bereik. |
| Key |
De belangrijkste resource. |
| KeyAttributes |
De objectkenmerken die worden beheerd door de Azure Key Vault-service. |
| KeyCreateParameters |
De parameters die worden gebruikt om een sleutel te maken. |
| KeyProperties |
De eigenschappen van de sleutel. |
| KeyReleasePolicy |
modelinterface KeyReleasePolicy |
| KeyRotationPolicyAttributes |
modelinterface KeyRotationPolicyAttributes |
| KeyVaultManagementClientOptionalParams |
Optionele parameters voor de client. |
| KeysCreateIfNotExistOptionalParams |
Optionele parameters. |
| KeysGetOptionalParams |
Optionele parameters. |
| KeysGetVersionOptionalParams |
Optionele parameters. |
| KeysListOptionalParams |
Optionele parameters. |
| KeysListVersionsOptionalParams |
Optionele parameters. |
| KeysOperations |
Interface die een Keys-operatie vertegenwoordigt. |
| LifetimeAction |
modelinterface LifetimeAction |
| LogSpecification |
Logboekspecificatie van de bewerking. |
| ManagedHSMSecurityDomainProperties |
De eigenschappen van het beveiligingsdomein van de beheerde hsm. |
| ManagedHsm |
Resourcegegevens met uitgebreide details. |
| ManagedHsmAction |
modelinterface ManagedHsmAction |
| ManagedHsmError |
De fout-uitzondering. |
| ManagedHsmKey |
De belangrijkste resource. |
| ManagedHsmKeyAttributes |
De objectkenmerken die worden beheerd door de Azure Key Vault-service. |
| ManagedHsmKeyCreateParameters |
De parameters die worden gebruikt om een sleutel te maken. |
| ManagedHsmKeyProperties |
De eigenschappen van de sleutel. |
| ManagedHsmKeyReleasePolicy |
modelinterface ManagedHsmKeyReleasePolicy |
| ManagedHsmKeyRotationPolicyAttributes |
modelinterface ManagedHsmKeyRotationPolicyAttributes |
| ManagedHsmKeysCreateIfNotExistOptionalParams |
Optionele parameters. |
| ManagedHsmKeysGetOptionalParams |
Optionele parameters. |
| ManagedHsmKeysGetVersionOptionalParams |
Optionele parameters. |
| ManagedHsmKeysListOptionalParams |
Optionele parameters. |
| ManagedHsmKeysListVersionsOptionalParams |
Optionele parameters. |
| ManagedHsmKeysOperations |
Interface die een ManagedHsmKeys-operatie vertegenwoordigt. |
| ManagedHsmLifetimeAction |
modelinterface ManagedHsmLifetimeAction |
| ManagedHsmProperties |
Eigenschappen van de beheerde HSM-pool |
| ManagedHsmRotationPolicy |
modelinterface ManagedHsmRotationPolicy |
| ManagedHsmSku |
SKU-details |
| ManagedHsmTrigger |
modelinterface ManagedHsmTrigger |
| ManagedHsmsCheckMhsmNameAvailabilityOptionalParams |
Optionele parameters. |
| ManagedHsmsCreateOrUpdateOptionalParams |
Optionele parameters. |
| ManagedHsmsDeleteOptionalParams |
Optionele parameters. |
| ManagedHsmsGetDeletedOptionalParams |
Optionele parameters. |
| ManagedHsmsGetOptionalParams |
Optionele parameters. |
| ManagedHsmsListByResourceGroupOptionalParams |
Optionele parameters. |
| ManagedHsmsListBySubscriptionOptionalParams |
Optionele parameters. |
| ManagedHsmsListDeletedOptionalParams |
Optionele parameters. |
| ManagedHsmsOperations |
Interface die een ManagedHsms-operatie vertegenwoordigt. |
| ManagedHsmsPurgeDeletedOptionalParams |
Optionele parameters. |
| ManagedHsmsUpdateOptionalParams |
Optionele parameters. |
| ManagedServiceIdentity |
Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten) |
| MetricSpecification |
Metrische specificatie van de bewerking. |
| MhsmGeoReplicatedRegion |
Een regio waarnaar deze beheerde HSM-pool is uitgebreid. |
| MhsmNetworkRuleSet |
Een set regels voor de netwerktoegankelijkheid van een beheerde hsm-pool. |
| MhsmPrivateEndpoint |
Eigenschappen van privé-eindpuntobjecten. |
| MhsmPrivateEndpointConnection |
Privé-eindpuntverbindingsresource. |
| MhsmPrivateEndpointConnectionItem |
Privé-eindpuntverbindingsitem. |
| MhsmPrivateEndpointConnectionProperties |
Eigenschappen van de private endpoint verbindingsbron. |
| MhsmPrivateEndpointConnectionsDeleteOptionalParams |
Optionele parameters. |
| MhsmPrivateEndpointConnectionsGetOptionalParams |
Optionele parameters. |
| MhsmPrivateEndpointConnectionsListByResourceOptionalParams |
Optionele parameters. |
| MhsmPrivateEndpointConnectionsOperations |
Interface die een MhsmPrivateEndpointConnections-operatie vertegenwoordigt. |
| MhsmPrivateEndpointConnectionsPutOptionalParams |
Optionele parameters. |
| MhsmPrivateLinkResource |
Een private link-resource |
| MhsmPrivateLinkResourceListResult |
Een lijst met private link-resources |
| MhsmPrivateLinkResourceProperties |
Eigenschappen van een private link-resource. |
| MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams |
Optionele parameters. |
| MhsmPrivateLinkResourcesOperations |
Interface die een MhsmPrivateLinkResources-operatie vertegenwoordigt. |
| MhsmPrivateLinkServiceConnectionState |
Een object dat de goedkeuringsstatus van de private link-verbinding vertegenwoordigt. |
| MhsmRegionsListByResourceOptionalParams |
Optionele parameters. |
| MhsmRegionsOperations |
Interface die een MhsmRegions-operatie vertegenwoordigt. |
| MhsmServiceTagRule |
Een regel die de toegankelijkheid van een beheerde hsm-pool regelt vanaf een specifieke servicetags. |
| MhsmVirtualNetworkRule |
Een regel voor de toegankelijkheid van een beheerde hsm-pool vanuit een specifiek virtueel netwerk. |
| MhsmipRule |
Een regel voor de toegankelijkheid van een beheerde HSM-pool van een specifiek IP-adres of IP-bereik. |
| NetworkRuleSet |
Een set regels voor de netwerktoegankelijkheid van een kluis. |
| Operation |
Key Vault REST API-bewerkingsdefinitie. |
| OperationDisplay |
Metagegevens weergeven die zijn gekoppeld aan de bewerking. |
| OperationProperties |
Eigenschappen van de werking, inclusief metrische specificaties. |
| OperationsListOptionalParams |
Optionele parameters. |
| OperationsOperations |
Interface voor bewerkingen. |
| PageSettings |
Opties voor de methode byPage |
| PagedAsyncIterableIterator |
Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina. |
| Permissions |
Machtigingen die de identiteit heeft voor sleutels, geheimen, certificaten en opslag. |
| PrivateEndpoint |
Eigenschappen van privé-eindpuntobjecten. |
| PrivateEndpointConnection |
Privé-eindpuntverbindingsresource. |
| PrivateEndpointConnectionItem |
Privé-eindpuntverbindingsitem. |
| PrivateEndpointConnectionProperties |
Eigenschappen van de private endpoint verbindingsbron. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Optionele parameters. |
| PrivateEndpointConnectionsGetOptionalParams |
Optionele parameters. |
| PrivateEndpointConnectionsListByResourceOptionalParams |
Optionele parameters. |
| PrivateEndpointConnectionsOperations |
Interface die een PrivateEndpointConnections-bewerking vertegenwoordigt. |
| PrivateEndpointConnectionsPutOptionalParams |
Optionele parameters. |
| PrivateLinkResource |
Een private link-resource |
| PrivateLinkResourceListResult |
Een lijst met private link-resources |
| PrivateLinkResourceProperties |
Eigenschappen van een private link-resource. |
| PrivateLinkResourcesListByVaultOptionalParams |
Optionele parameters. |
| PrivateLinkResourcesOperations |
Interface die een PrivateLinkResources-bewerking vertegenwoordigt. |
| PrivateLinkServiceConnectionState |
Een object dat de goedkeuringsstatus van de private link-verbinding vertegenwoordigt. |
| ProxyResource |
De definitie van het resourcemodel voor een Azure Resource Manager-proxyresource. Het heeft geen tags en een locatie |
| Resource |
Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources |
| RestorePollerOptions | |
| RotationPolicy |
modelinterface RotationPolicy |
| Secret |
Resourcegegevens met uitgebreide details. |
| SecretAttributes |
De geheime beheerkenmerken. |
| SecretCreateOrUpdateParameters |
Parameters voor het maken of bijwerken van een geheim |
| SecretPatchParameters |
Parameters voor het patchen van een geheim |
| SecretPatchProperties |
Eigenschappen van het geheim |
| SecretProperties |
Eigenschappen van het geheim |
| SecretsCreateOrUpdateOptionalParams |
Optionele parameters. |
| SecretsGetOptionalParams |
Optionele parameters. |
| SecretsListOptionalParams |
Optionele parameters. |
| SecretsOperations |
Interface die een Secrets-operatie vertegenwoordigt. |
| SecretsUpdateOptionalParams |
Optionele parameters. |
| ServiceSpecification |
Eén eigenschap van de bewerking, bevatten logboekspecificaties. |
| SimplePollerLike |
Een eenvoudige poller die kan worden gebruikt om een langdurige bewerking te peilen. |
| Sku |
SKU-details |
| SystemData |
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource. |
| TrackedResource |
De definitie van het resourcemodel voor een azure Resource Manager heeft een resource op het hoogste niveau bijgehouden met tags en een locatie |
| Trigger |
modelinterface Trigger |
| UserAssignedIdentity |
Door de gebruiker toegewezen identiteitseigenschappen |
| Vault |
Resourcegegevens met uitgebreide details. |
| VaultAccessPolicyParameters |
Parameters voor het bijwerken van het toegangsbeleid in een kluis |
| VaultAccessPolicyProperties |
Eigenschappen van het toegangsbeleid voor de kluis |
| VaultCheckNameAvailabilityParameters |
De parameters die worden gebruikt om de beschikbaarheid van de kluisnaam te controleren. |
| VaultCreateOrUpdateParameters |
Parameters voor het maken of bijwerken van een kluis |
| VaultPatchParameters |
Parameters voor het maken of bijwerken van een kluis |
| VaultPatchProperties |
Eigenschappen van de kluis |
| VaultProperties |
Eigenschappen van de kluis |
| VaultsCheckNameAvailabilityOptionalParams |
Optionele parameters. |
| VaultsCreateOrUpdateOptionalParams |
Optionele parameters. |
| VaultsDeleteOptionalParams |
Optionele parameters. |
| VaultsGetDeletedOptionalParams |
Optionele parameters. |
| VaultsGetOptionalParams |
Optionele parameters. |
| VaultsListByResourceGroupOptionalParams |
Optionele parameters. |
| VaultsListBySubscriptionOptionalParams |
Optionele parameters. |
| VaultsListDeletedOptionalParams |
Optionele parameters. |
| VaultsListOptionalParams |
Optionele parameters. |
| VaultsOperations |
Interface die een Vaults-bewerkingen vertegenwoordigt. |
| VaultsPurgeDeletedOptionalParams |
Optionele parameters. |
| VaultsUpdateAccessPolicyOptionalParams |
Optionele parameters. |
| VaultsUpdateOptionalParams |
Optionele parameters. |
| VirtualNetworkRule |
Een regel voor de toegankelijkheid van een kluis vanuit een specifiek virtueel netwerk. |
Type-aliassen
| AccessPolicyUpdateKind |
Type of AccessPolicyUpdateKind |
| ActionsRequired |
Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen. Bekende waarden die door de service worden ondersteundGeen |
| ActivationStatus |
Activatiestatus Bekende waarden die door de service worden ondersteund
Actief: de beheerde HSM-pool is actief. |
| AzureSupportedClouds |
De ondersteunde waarden voor cloudinstelling als een letterlijk tekenreekstype |
| CertificatePermissions |
Type certificaatRechtenRechten |
| ContinuablePage |
Een interface die een pagina met resultaten beschrijft. |
| CreateMode |
De maakmodus van de kluis om aan te geven of de kluis moet worden hersteld of niet. |
| CreatedByType |
Het type entiteit dat de resource heeft gemaakt. Bekende waarden die door de service worden ondersteund
Gebruiker: de entiteit is gemaakt door een gebruiker. |
| DeletionRecoveryLevel |
Het verwijderingsherstelniveau dat momenteel van kracht is voor het object. Als het 'Purgeable' bevat, kan het object permanent worden verwijderd door een bevoorrechte gebruiker; anders kan alleen het systeem het object aan het einde van het retentieinterval zuiveren. Bekende waarden die door de service worden ondersteund
verwijderbare |
| GeoReplicationRegionProvisioningState |
De huidige inrichtingsstatus. Bekende waarden die door de service worden ondersteund
vooraf inrichten van |
| JsonWebKeyCurveName |
De naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden. Standaard voor EC- en EC-HSM-toetsen is P-256 Bekende waarden die door de service worden ondersteund
P-256- |
| JsonWebKeyOperation |
De toegestane JSON-websleuteloperaties van de sleutel. Zie JsonWebKeyOperation voor meer informatie. Bekende waarden die door de service worden ondersteund
versleutelen |
| JsonWebKeyType |
Het type sleutel. Zie JsonWebKeyType voor geldige waarden. Bekende waarden die door de service worden ondersteund
EG- |
| KeyPermissions |
Type of KeyPermissions |
| KeyRotationPolicyActionType |
Het type actie. |
| ManagedHsmSkuFamily |
SKU-familie van de beheerde HSM Pool Bekende waarden die door de service worden ondersteund
B- |
| ManagedHsmSkuName |
SKU van de beheerde HSM-pool |
| ManagedServiceIdentityType |
Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan). Bekende waarden die door de service worden ondersteund
Geen: Geen beheerde identiteit. |
| NetworkRuleAction |
De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomt. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd. Bekende waarden die door de service worden ondersteund
toestaan |
| NetworkRuleBypassOptions |
Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'Geen' zijn. Als de standaardwaarde niet is opgegeven, is 'AzureServices'. Bekende waarden die door de service worden ondersteund
AzureServices- |
| PrivateEndpointConnectionProvisioningState |
De huidige inrichtingsstatus. Bekende waarden die door de service worden ondersteund
geslaagde |
| PrivateEndpointServiceConnectionStatus |
De verbindingsstatus van het privé-eindpunt. Bekende waarden die door de service worden ondersteund
in behandeling |
| ProvisioningState |
Inrichtingsstatus. Bekende waarden die door de service worden ondersteund
Geslaagde: de beheerde HSM-pool is volledig ingericht. |
| PublicNetworkAccess |
Beheermachtigingen voor de beheerde HSM vanuit openbare netwerken. Bekende waarden die door de service worden ondersteund
ingeschakelde |
| Reason |
De reden dat een kluisnaam niet kon worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is. Bekende waarden die door de service worden ondersteund
AccountNameInvalid |
| SecretPermissions |
Type of SecretPermissions |
| SkuFamily |
SKU-familienaam Bekende waarden die door de service worden ondersteundA- |
| SkuName |
SKU-naam om op te geven of de sleutelkluis een standaardkluis of een Premium-kluis is. |
| StoragePermissions |
Type of StoragePermissions |
| VaultProvisioningState |
Inrichtingsstatus van de kluis. Bekende waarden die door de service worden ondersteund
geslaagde |
Enums
| AzureClouds |
Een enum om Azure Cloud-omgevingen te beschrijven. |
| KnownActionsRequired |
Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen. |
| KnownActivationStatus |
Status van activering |
| KnownCertificatePermissions |
Bekende waarden van CertificatePermissions die de service accepteert. |
| KnownCreatedByType |
Het type entiteit dat de resource heeft gemaakt. |
| KnownDeletionRecoveryLevel |
Het verwijderingsherstelniveau dat momenteel van kracht is voor het object. Als het 'Purgeable' bevat, kan het object permanent worden verwijderd door een bevoorrechte gebruiker; anders kan alleen het systeem het object aan het einde van het retentieinterval zuiveren. |
| KnownGeoReplicationRegionProvisioningState |
De huidige inrichtingsstatus. |
| KnownJsonWebKeyCurveName |
De naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden. Standaardwaarde voor EC- en EC-HSM-sleutels is P-256 |
| KnownJsonWebKeyOperation |
De toegestane JSON-websleuteloperaties van de sleutel. Zie JsonWebKeyOperation voor meer informatie. |
| KnownJsonWebKeyType |
Het type sleutel. Zie JsonWebKeyType voor geldige waarden. |
| KnownKeyPermissions |
Bekende waarden van KeyPermissions die de service accepteert. |
| KnownManagedHsmSkuFamily |
SKU-familie van de beheerde HSM-pool |
| KnownManagedServiceIdentityType |
Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan). |
| KnownNetworkRuleAction |
De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomt. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd. |
| KnownNetworkRuleBypassOptions |
Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'Geen' zijn. Als de standaardwaarde niet is opgegeven, is 'AzureServices'. |
| KnownPrivateEndpointConnectionProvisioningState |
De huidige inrichtingsstatus. |
| KnownPrivateEndpointServiceConnectionStatus |
De verbindingsstatus van het privé-eindpunt. |
| KnownProvisioningState |
Inrichtingsstatus. |
| KnownPublicNetworkAccess |
Beheermachtigingen voor de beheerde HSM vanuit openbare netwerken. |
| KnownReason |
De reden dat een kluisnaam niet kon worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is. |
| KnownSecretPermissions |
Bekende waarden van SecretPermissions die de service accepteert. |
| KnownSkuFamily |
Familienaam van SKU |
| KnownStoragePermissions |
Bekende waarden van StoragePermissions die de service accepteert. |
| KnownVaultProvisioningState |
Inrichtingsstatus van de kluis. |
| KnownVersions |
De beschikbare API-versies. |
Functies
| restore |
Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt. |
Functiedetails
restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.
function restorePoller<TResponse, TResult>(client: KeyVaultManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- KeyVaultManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Retouren
PollerLike<OperationState<TResult>, TResult>