@azure/arm-keyvault package
Klasy
| KeyVaultManagementClient |
Interfejsy
| AccessPolicyEntry |
Tożsamość, która ma dostęp do magazynu kluczy. Wszystkie tożsamości w tablicy muszą używać tego samego identyfikatora dzierżawy co identyfikator dzierżawy magazynu kluczy. |
| Action |
Interfejs modelu Akcja |
| Attributes |
Atrybuty obiektu zarządzane przez usługę KeyVault. |
| CheckMhsmNameAvailabilityParameters |
Parametry używane do sprawdzania dostępności nazwy zarządzanego modułu hsm. |
| CheckMhsmNameAvailabilityResult |
Odpowiedź operacji CheckMhsmNameAvailability. |
| CheckNameAvailabilityResult |
Odpowiedź operacji CheckNameAvailability. |
| CloudError |
Odpowiedź na błąd dostawcy zasobów usługi Key Vault |
| CloudErrorBody |
Odpowiedź na błąd dostawcy zasobów usługi Key Vault |
| DeletedManagedHsm |
Konkretne typy zasobów serwera proxy można utworzyć, aliasując ten typ przy użyciu określonego typu właściwości. |
| DeletedManagedHsmProperties |
Właściwości usuniętego zarządzanego modułu HSM. |
| DeletedVault |
Usunięte informacje o magazynie z rozszerzonymi szczegółami. |
| DeletedVaultProperties |
Właściwości usuniętego magazynu. |
| DimensionProperties |
Typ operacji: pobieranie, odczytywanie, usuwanie itp. |
| ErrorModel |
Błąd serwera. |
| IPRule |
Reguła regulująca dostępność magazynu z określonego adresu IP lub zakresu adresów IP. |
| Key |
Zasób klucza. |
| KeyAttributes |
Atrybuty obiektu zarządzane przez usługę Azure Key Vault. |
| KeyCreateParameters |
Parametry używane do tworzenia klucza. |
| KeyProperties |
Właściwości klucza. |
| KeyReleasePolicy |
interfejs modelu KeyReleasePolicy |
| KeyRotationPolicyAttributes |
interfejs modelu KeyRotationPolicyAttributes |
| KeyVaultManagementClientOptionalParams |
Parametry opcjonalne dla klienta. |
| KeysCreateIfNotExistOptionalParams |
Parametry opcjonalne. |
| KeysGetOptionalParams |
Parametry opcjonalne. |
| KeysGetVersionOptionalParams |
Parametry opcjonalne. |
| KeysListOptionalParams |
Parametry opcjonalne. |
| KeysListVersionsOptionalParams |
Parametry opcjonalne. |
| KeysOperations |
Interfejs reprezentujący operacje Klucze. |
| LifetimeAction |
interfejs modelu LifetimeAction |
| LogSpecification |
Specyfikacja dziennika operacji. |
| ManagedHSMSecurityDomainProperties |
Właściwości domeny zabezpieczeń zarządzanego modułu hsm. |
| ManagedHsm |
Informacje o zasobach z rozszerzonymi szczegółami. |
| ManagedHsmAction |
interfejs modelu ManagedHsmAction |
| ManagedHsmError |
Wyjątek błędu. |
| ManagedHsmKey |
Zasób klucza. |
| ManagedHsmKeyAttributes |
Atrybuty obiektu zarządzane przez usługę Azure Key Vault. |
| ManagedHsmKeyCreateParameters |
Parametry używane do tworzenia klucza. |
| ManagedHsmKeyProperties |
Właściwości klucza. |
| ManagedHsmKeyReleasePolicy |
interfejs modelu ManagedHsmKeyReleasePolicy |
| ManagedHsmKeyRotationPolicyAttributes |
interfejs modelu ManagedHsmKeyRotationPolicyAttributes |
| ManagedHsmKeysCreateIfNotExistOptionalParams |
Parametry opcjonalne. |
| ManagedHsmKeysGetOptionalParams |
Parametry opcjonalne. |
| ManagedHsmKeysGetVersionOptionalParams |
Parametry opcjonalne. |
| ManagedHsmKeysListOptionalParams |
Parametry opcjonalne. |
| ManagedHsmKeysListVersionsOptionalParams |
Parametry opcjonalne. |
| ManagedHsmKeysOperations |
Interfejs reprezentujący operacje ManagedHsmKeys. |
| ManagedHsmLifetimeAction |
interfejs modelu ManagedHsmLifetimeAction |
| ManagedHsmProperties |
Właściwości zarządzanej puli modułów HSM |
| ManagedHsmRotationPolicy |
interfejs modelu ManagedHsmRotationPolicy |
| ManagedHsmSku |
Szczegóły jednostki SKU |
| ManagedHsmTrigger |
interfejs modelu ManagedHsmTrigger |
| ManagedHsmsCheckMhsmNameAvailabilityOptionalParams |
Parametry opcjonalne. |
| ManagedHsmsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| ManagedHsmsDeleteOptionalParams |
Parametry opcjonalne. |
| ManagedHsmsGetDeletedOptionalParams |
Parametry opcjonalne. |
| ManagedHsmsGetOptionalParams |
Parametry opcjonalne. |
| ManagedHsmsListByResourceGroupOptionalParams |
Parametry opcjonalne. |
| ManagedHsmsListBySubscriptionOptionalParams |
Parametry opcjonalne. |
| ManagedHsmsListDeletedOptionalParams |
Parametry opcjonalne. |
| ManagedHsmsOperations |
Interfejs reprezentujący operacje ManagedHsms. |
| ManagedHsmsPurgeDeletedOptionalParams |
Parametry opcjonalne. |
| ManagedHsmsUpdateOptionalParams |
Parametry opcjonalne. |
| ManagedServiceIdentity |
Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika) |
| MetricSpecification |
Specyfikacja metryki operacji. |
| MhsmGeoReplicatedRegion |
Region, do którego rozszerzono tę zarządzaną pulę modułów HSM. |
| MhsmNetworkRuleSet |
Zestaw reguł, które regulują dostępność sieci zarządzanej puli modułów HSM. |
| MhsmPrivateEndpoint |
Właściwości obiektu prywatnego punktu końcowego. |
| MhsmPrivateEndpointConnection |
Zasób połączenia prywatnego punktu końcowego. |
| MhsmPrivateEndpointConnectionItem |
Element połączenia prywatnego punktu końcowego. |
| MhsmPrivateEndpointConnectionProperties |
Właściwości prywatnego zasobu połączenia końcowego. |
| MhsmPrivateEndpointConnectionsDeleteOptionalParams |
Parametry opcjonalne. |
| MhsmPrivateEndpointConnectionsGetOptionalParams |
Parametry opcjonalne. |
| MhsmPrivateEndpointConnectionsListByResourceOptionalParams |
Parametry opcjonalne. |
| MhsmPrivateEndpointConnectionsOperations |
Interfejs reprezentujący operacje MhsmPrivateEndpointConnections. |
| MhsmPrivateEndpointConnectionsPutOptionalParams |
Parametry opcjonalne. |
| MhsmPrivateLinkResource |
Zasób łącza prywatnego |
| MhsmPrivateLinkResourceListResult |
Lista zasobów łącza prywatnego |
| MhsmPrivateLinkResourceProperties |
Właściwości zasobu łącza prywatnego. |
| MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams |
Parametry opcjonalne. |
| MhsmPrivateLinkResourcesOperations |
Interfejs reprezentujący operacje MhsmPrivateLinkResources. |
| MhsmPrivateLinkServiceConnectionState |
Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego. |
| MhsmRegionsListByResourceOptionalParams |
Parametry opcjonalne. |
| MhsmRegionsOperations |
Interfejs reprezentujący operacje MhsmRegions. |
| MhsmServiceTagRule |
Reguła regulująca dostępność zarządzanej puli HSM na podstawie konkretnych tagów usługowych. |
| MhsmVirtualNetworkRule |
Reguła rządząca ułatwieniami dostępu zarządzanej puli hsm z określonej sieci wirtualnej. |
| MhsmipRule |
Reguła rządząca ułatwieniami dostępu zarządzanej puli modułów HSM z określonego adresu IP lub zakresu adresów IP. |
| NetworkRuleSet |
Zestaw reguł, które regulują dostępność sieci magazynu. |
| Operation |
Definicja operacji interfejsu API REST usługi Key Vault. |
| OperationDisplay |
Wyświetl metadane skojarzone z operacją. |
| OperationProperties |
Właściwości działania, w tym specyfikacje metryk. |
| OperationsListOptionalParams |
Parametry opcjonalne. |
| OperationsOperations |
Interfejs reprezentujący operacje. |
| PageSettings |
Opcje dla metody byPage |
| PagedAsyncIterableIterator |
Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony. |
| Permissions |
Uprawnienia tożsamości są dostępne dla kluczy, wpisów tajnych, certyfikatów i magazynu. |
| PrivateEndpoint |
Właściwości obiektu prywatnego punktu końcowego. |
| PrivateEndpointConnection |
Zasób połączenia prywatnego punktu końcowego. |
| PrivateEndpointConnectionItem |
Element połączenia prywatnego punktu końcowego. |
| PrivateEndpointConnectionProperties |
Właściwości prywatnego zasobu połączenia końcowego. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsGetOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsListByResourceOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsOperations |
Interfejs reprezentujący operacje PrivateEndpointConnections. |
| PrivateEndpointConnectionsPutOptionalParams |
Parametry opcjonalne. |
| PrivateLinkResource |
Zasób łącza prywatnego |
| PrivateLinkResourceListResult |
Lista zasobów łącza prywatnego |
| PrivateLinkResourceProperties |
Właściwości zasobu łącza prywatnego. |
| PrivateLinkResourcesListByVaultOptionalParams |
Parametry opcjonalne. |
| PrivateLinkResourcesOperations |
Interfejs reprezentujący operacje PrivateLinkResources. |
| PrivateLinkServiceConnectionState |
Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego. |
| ProxyResource |
Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów i lokalizacji |
| Resource |
Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager |
| RestorePollerOptions | |
| RotationPolicy |
Interfejs modelu Polityka rotacji |
| Secret |
Informacje o zasobach z rozszerzonymi szczegółami. |
| SecretAttributes |
Atrybuty zarządzania wpisami tajnymi. |
| SecretCreateOrUpdateParameters |
Parametry tworzenia lub aktualizowania wpisu tajnego |
| SecretPatchParameters |
Parametry stosowania poprawek wpisu tajnego |
| SecretPatchProperties |
Właściwości wpisu tajnego |
| SecretProperties |
Właściwości wpisu tajnego |
| SecretsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| SecretsGetOptionalParams |
Parametry opcjonalne. |
| SecretsListOptionalParams |
Parametry opcjonalne. |
| SecretsOperations |
Interfejs reprezentujący operacje Secrets. |
| SecretsUpdateOptionalParams |
Parametry opcjonalne. |
| ServiceSpecification |
Jedna właściwość operacji zawiera specyfikacje dziennika. |
| SimplePollerLike |
Prosty poller, który może służyć do sondowania długotrwałej operacji. |
| Sku |
Szczegóły jednostki SKU |
| SystemData |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
| TrackedResource |
Definicja modelu zasobów dla zasobu usługi Azure Resource Manager śledziła zasób najwyższego poziomu, który ma "tagi" i "lokalizację" |
| Trigger |
Interfejs modelu Trigger |
| UserAssignedIdentity |
Właściwości tożsamości przypisanej przez użytkownika |
| Vault |
Informacje o zasobach z rozszerzonymi szczegółami. |
| VaultAccessPolicyParameters |
Parametry aktualizowania zasad dostępu w magazynie |
| VaultAccessPolicyProperties |
Właściwości zasad dostępu do magazynu |
| VaultCheckNameAvailabilityParameters |
Parametry używane do sprawdzania dostępności nazwy magazynu. |
| VaultCreateOrUpdateParameters |
Parametry tworzenia lub aktualizowania magazynu |
| VaultPatchParameters |
Parametry tworzenia lub aktualizowania magazynu |
| VaultPatchProperties |
Właściwości magazynu |
| VaultProperties |
Właściwości magazynu |
| VaultsCheckNameAvailabilityOptionalParams |
Parametry opcjonalne. |
| VaultsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| VaultsDeleteOptionalParams |
Parametry opcjonalne. |
| VaultsGetDeletedOptionalParams |
Parametry opcjonalne. |
| VaultsGetOptionalParams |
Parametry opcjonalne. |
| VaultsListByResourceGroupOptionalParams |
Parametry opcjonalne. |
| VaultsListBySubscriptionOptionalParams |
Parametry opcjonalne. |
| VaultsListDeletedOptionalParams |
Parametry opcjonalne. |
| VaultsListOptionalParams |
Parametry opcjonalne. |
| VaultsOperations |
Interfejs reprezentujący operacje Vaults. |
| VaultsPurgeDeletedOptionalParams |
Parametry opcjonalne. |
| VaultsUpdateAccessPolicyOptionalParams |
Parametry opcjonalne. |
| VaultsUpdateOptionalParams |
Parametry opcjonalne. |
| VirtualNetworkRule |
Reguła regulująca dostępność magazynu z określonej sieci wirtualnej. |
Aliasy typu
| AccessPolicyUpdateKind |
Rodzaj AccessPolicyUpdateKind |
| ActionsRequired |
Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy. Znane wartości obsługiwane przez usługęBrak |
| ActivationStatus |
Status aktywacji Znane wartości obsługiwane przez usługę
aktywne: zarządzana pula modułów HSM jest aktywna. |
| AzureSupportedClouds |
Obsługiwane wartości ustawienia chmury jako typ literału ciągu |
| CertificatePermissions |
Typ certyfikatuUprawnienia |
| ContinuablePage |
Interfejs opisujący stronę wyników. |
| CreateMode |
Tryb tworzenia magazynu, aby wskazać, czy magazyn musi zostać odzyskany, czy nie. |
| CreatedByType |
Rodzaj jednostki, która utworzyła zasób. Znane wartości obsługiwane przez usługę
użytkownik: jednostka została utworzona przez użytkownika. |
| DeletionRecoveryLevel |
Poziom odzyskiwania usunięcia jest obecnie obowiązujący dla obiektu. Jeśli zawiera "Czyścicielne", obiekt może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może usunąć obiekt na końcu interwału retencyjnego. Znane wartości obsługiwane przez usługę
do przeczyszczania |
| GeoReplicationRegionProvisioningState |
Bieżący stan aprowizacji. Znane wartości obsługiwane przez usługę
wstępne aprowizowanie |
| JsonWebKeyCurveName |
Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName. Domyślne dla kluczy EC i EC-HSM to P-256 Znane wartości obsługiwane przez usługę
P-256 |
| JsonWebKeyOperation |
Dozwolone operacje klucza sieciowego JSON dla klucza. Aby uzyskać więcej informacji, zobacz JsonWebKeyOperation. Znane wartości obsługiwane przez usługęszyfrowanie |
| JsonWebKeyType |
Typ klucza. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyType. Znane wartości obsługiwane przez usługę
WE |
| KeyPermissions |
Typ KeyPermissions |
| KeyRotationPolicyActionType |
Typ akcji. |
| ManagedHsmSkuFamily |
Rodzina SKU zarządzanej puli HSM Znane wartości obsługiwane przez usługę
B |
| ManagedHsmSkuName |
Jednostka SKU zarządzanej puli modułów HSM |
| ManagedServiceIdentityType |
Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). Znane wartości obsługiwane przez usługę
Brak: Brak tożsamości zarządzanej. |
| NetworkRuleAction |
Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia. Znane wartości obsługiwane przez usługę
Zezwalaj na |
| NetworkRuleBypassOptions |
Informuje, jaki ruch może pomijać reguły sieci. Może to być wartość "AzureServices" lub "None". Jeśli nie określono wartości domyślnej, to "AzureServices". Znane wartości obsługiwane przez usługę
AzureServices |
| PrivateEndpointConnectionProvisioningState |
Bieżący stan aprowizacji. Znane wartości obsługiwane przez usługę
powodzeniem |
| PrivateEndpointServiceConnectionStatus |
Stan połączenia prywatnego punktu końcowego. Znane wartości obsługiwane przez usługę
oczekujące |
| ProvisioningState |
Stan aprowizacji. Znane wartości obsługiwane przez usługę
powodzeniem: zarządzana pula modułów HSM została w pełni aprowizowana. |
| PublicNetworkAccess |
Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych. Znane wartości obsługiwane przez usługę
włączone |
| Reason |
Powód, dla którego nie można użyć nazwy magazynu. Element Reason jest zwracany tylko wtedy, gdy nameAvailable ma wartość false. Znane wartości obsługiwane przez usługę
AccountNameInvalid |
| SecretPermissions |
Rodzaj SecretPermissions |
| SkuFamily |
Nazwisko SKU Znane wartości obsługiwane przez usługęA |
| SkuName |
Nazwa jednostki SKU określająca, czy magazyn kluczy jest magazynem w warstwie Standardowa, czy magazynem w warstwie Premium. |
| StoragePermissions |
Typ uprawnień do przechowywania danych |
| VaultProvisioningState |
Stan aprowizacji magazynu. Znane wartości obsługiwane przez usługę
powodzeniem |
Wyliczenia
| AzureClouds |
Wyliczenie opisujące środowiska chmury platformy Azure. |
| KnownActionsRequired |
Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy. |
| KnownActivationStatus |
Stan aktywacji |
| KnownCertificatePermissions |
Znane wartości CertificatePermissions, które akceptuje usługa. |
| KnownCreatedByType |
Rodzaj jednostki, która utworzyła zasób. |
| KnownDeletionRecoveryLevel |
Poziom odzyskiwania usunięcia jest obecnie obowiązujący dla obiektu. Jeśli zawiera "Czyścicielne", obiekt może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może usunąć obiekt na końcu interwału retencyjnego. |
| KnownGeoReplicationRegionProvisioningState |
Bieżący stan aprowizacji. |
| KnownJsonWebKeyCurveName |
Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName. Wartość domyślna dla kluczy EC i EC-HSM to P-256 |
| KnownJsonWebKeyOperation |
Dozwolone operacje klucza sieciowego JSON dla klucza. Aby uzyskać więcej informacji, zobacz JsonWebKeyOperation. |
| KnownJsonWebKeyType |
Typ klucza. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyType. |
| KnownKeyPermissions |
Znane wartości KeyPermissions, które akceptuje usługa. |
| KnownManagedHsmSkuFamily |
Rodzina jednostek SKU zarządzanej puli modułów HSM |
| KnownManagedServiceIdentityType |
Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). |
| KnownNetworkRuleAction |
Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia. |
| KnownNetworkRuleBypassOptions |
Informuje, jaki ruch może pomijać reguły sieci. Może to być wartość "AzureServices" lub "None". Jeśli nie określono wartości domyślnej, to "AzureServices". |
| KnownPrivateEndpointConnectionProvisioningState |
Bieżący stan aprowizacji. |
| KnownPrivateEndpointServiceConnectionStatus |
Stan połączenia prywatnego punktu końcowego. |
| KnownProvisioningState |
Stan aprowizacji. |
| KnownPublicNetworkAccess |
Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych. |
| KnownReason |
Powód, dla którego nie można użyć nazwy magazynu. Element Reason jest zwracany tylko wtedy, gdy nameAvailable ma wartość false. |
| KnownSecretPermissions |
Znane wartości SecretPermissions, które akceptuje usługa. |
| KnownSkuFamily |
Nazwa rodziny jednostek SKU |
| KnownStoragePermissions |
Znane wartości StoragePermissions, które akceptuje usługa. |
| KnownVaultProvisioningState |
Stan aprowizacji magazynu. |
| KnownVersions |
Dostępne wersje interfejsu API. |
Funkcje
| restore |
Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie. |
Szczegóły funkcji
restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.
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>
Zwraca
PollerLike<OperationState<TResult>, TResult>