@azure/arm-keyvault package
Clases
| KeyVaultManagementClient |
Interfaces
| AccessPolicyEntry |
Identidad que tiene acceso al almacén de claves. Todas las identidades de la matriz deben usar el mismo identificador de inquilino que el identificador de inquilino del almacén de claves. |
| Action |
Acción de la interfaz modelo |
| Attributes |
Atributos de objeto administrados por el servicio KeyVault. |
| CheckMhsmNameAvailabilityParameters |
Parámetros usados para comprobar la disponibilidad del nombre hsm administrado. |
| CheckMhsmNameAvailabilityResult |
Respuesta de la operación CheckMhsmNameAvailability. |
| CheckNameAvailabilityResult |
Respuesta de la operación CheckNameAvailability. |
| CloudError |
Respuesta de error del proveedor de recursos de Key Vault |
| CloudErrorBody |
Respuesta de error del proveedor de recursos de Key Vault |
| DeletedManagedHsm |
Los tipos de recursos de proxy concretos se pueden crear mediante el alias de este tipo mediante un tipo de propiedad específico. |
| DeletedManagedHsmProperties |
Propiedades del HSM administrado eliminado. |
| DeletedVault |
Información del almacén eliminada con detalles extendidos. |
| DeletedVaultProperties |
Propiedades del almacén eliminado. |
| DimensionProperties |
Tipo de operación: obtener, leer, eliminar, etc. |
| ErrorModel |
Error del servidor. |
| IPRule |
Una regla que rige la accesibilidad de un almacén desde una dirección IP específica o un intervalo ip. |
| Key |
Recurso de clave. |
| KeyAttributes |
Atributos de objeto administrados por el servicio Azure Key Vault. |
| KeyCreateParameters |
Parámetros usados para crear una clave. |
| KeyProperties |
Propiedades de la clave. |
| KeyReleasePolicy |
interfaz de modelo KeyReleasePolicy |
| KeyRotationPolicyAttributes |
interfaz de modelo KeyRotationPolicyAttributes |
| KeyVaultManagementClientOptionalParams |
Parámetros opcionales para el cliente. |
| KeysCreateIfNotExistOptionalParams |
Parámetros opcionales. |
| KeysGetOptionalParams |
Parámetros opcionales. |
| KeysGetVersionOptionalParams |
Parámetros opcionales. |
| KeysListOptionalParams |
Parámetros opcionales. |
| KeysListVersionsOptionalParams |
Parámetros opcionales. |
| KeysOperations |
Interfaz que representa operaciones de llaves. |
| LifetimeAction |
interfaz de modelo LifetimeAction |
| LogSpecification |
Especificación de registro de la operación. |
| ManagedHSMSecurityDomainProperties |
Las propiedades del dominio de seguridad del hsm administrado. |
| ManagedHsm |
Información de recursos con detalles extendidos. |
| ManagedHsmAction |
interfaz de modelo ManagedHsmAction |
| ManagedHsmError |
Excepción de error. |
| ManagedHsmKey |
Recurso de clave. |
| ManagedHsmKeyAttributes |
Atributos de objeto administrados por el servicio Azure Key Vault. |
| ManagedHsmKeyCreateParameters |
Parámetros usados para crear una clave. |
| ManagedHsmKeyProperties |
Propiedades de la clave. |
| ManagedHsmKeyReleasePolicy |
interfaz de modelos ManagedHsmKeyReleasePolicy |
| ManagedHsmKeyRotationPolicyAttributes |
interfaz modelo GestionadoHsmKeyRotationPolicyAttributes |
| ManagedHsmKeysCreateIfNotExistOptionalParams |
Parámetros opcionales. |
| ManagedHsmKeysGetOptionalParams |
Parámetros opcionales. |
| ManagedHsmKeysGetVersionOptionalParams |
Parámetros opcionales. |
| ManagedHsmKeysListOptionalParams |
Parámetros opcionales. |
| ManagedHsmKeysListVersionsOptionalParams |
Parámetros opcionales. |
| ManagedHsmKeysOperations |
Interfaz que representa una operación ManagedHsmKeys. |
| ManagedHsmLifetimeAction |
interfaz de modelo ManagedHsmLifetimeAction |
| ManagedHsmProperties |
Propiedades del grupo de HSM administrado |
| ManagedHsmRotationPolicy |
interfaz de modelo ManagedHsmRotationPolicy |
| ManagedHsmSku |
Detalles de la SKU |
| ManagedHsmTrigger |
interfaz modelo ManagedHsmTrigger |
| ManagedHsmsCheckMhsmNameAvailabilityOptionalParams |
Parámetros opcionales. |
| ManagedHsmsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| ManagedHsmsDeleteOptionalParams |
Parámetros opcionales. |
| ManagedHsmsGetDeletedOptionalParams |
Parámetros opcionales. |
| ManagedHsmsGetOptionalParams |
Parámetros opcionales. |
| ManagedHsmsListByResourceGroupOptionalParams |
Parámetros opcionales. |
| ManagedHsmsListBySubscriptionOptionalParams |
Parámetros opcionales. |
| ManagedHsmsListDeletedOptionalParams |
Parámetros opcionales. |
| ManagedHsmsOperations |
Interfaz que representa una operación ManagedHsms. |
| ManagedHsmsPurgeDeletedOptionalParams |
Parámetros opcionales. |
| ManagedHsmsUpdateOptionalParams |
Parámetros opcionales. |
| ManagedServiceIdentity |
Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario) |
| MetricSpecification |
Especificación de métricas de la operación. |
| MhsmGeoReplicatedRegion |
Región a la que se ha ampliado este grupo de HSM administrado. |
| MhsmNetworkRuleSet |
Conjunto de reglas que rigen la accesibilidad de red de un grupo de hsm administrado. |
| MhsmPrivateEndpoint |
Propiedades del objeto de punto de conexión privado. |
| MhsmPrivateEndpointConnection |
Recurso de conexión de punto de conexión privado. |
| MhsmPrivateEndpointConnectionItem |
Elemento de conexión de punto de conexión privado. |
| MhsmPrivateEndpointConnectionProperties |
Propiedades del recurso de conexión de punto final privado. |
| MhsmPrivateEndpointConnectionsDeleteOptionalParams |
Parámetros opcionales. |
| MhsmPrivateEndpointConnectionsGetOptionalParams |
Parámetros opcionales. |
| MhsmPrivateEndpointConnectionsListByResourceOptionalParams |
Parámetros opcionales. |
| MhsmPrivateEndpointConnectionsOperations |
Interfaz que representa una operación MhsmPrivateEndpointConnections. |
| MhsmPrivateEndpointConnectionsPutOptionalParams |
Parámetros opcionales. |
| MhsmPrivateLinkResource |
Un recurso de vínculo privado |
| MhsmPrivateLinkResourceListResult |
Lista de recursos de private link |
| MhsmPrivateLinkResourceProperties |
Propiedades de un recurso de vínculo privado. |
| MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams |
Parámetros opcionales. |
| MhsmPrivateLinkResourcesOperations |
Interfaz que representa una operación MhsmPrivateLinkResources. |
| MhsmPrivateLinkServiceConnectionState |
Objeto que representa el estado de aprobación de la conexión de vínculo privado. |
| MhsmRegionsListByResourceOptionalParams |
Parámetros opcionales. |
| MhsmRegionsOperations |
Interfaz que representa una operación de MhsmRegions. |
| MhsmServiceTagRule |
Una norma que regula la accesibilidad de un pool HSM gestionado a partir de etiquetas de servicio específicas. |
| MhsmVirtualNetworkRule |
Una regla que rige la accesibilidad de un grupo de hsm administrado desde una red virtual específica. |
| MhsmipRule |
Una regla que rige la accesibilidad de un grupo de HSM administrado desde una dirección IP específica o un intervalo IP. |
| NetworkRuleSet |
Conjunto de reglas que rigen la accesibilidad de red de un almacén. |
| Operation |
Definición de la operación de la API REST de Key Vault. |
| OperationDisplay |
Mostrar metadatos asociados a la operación. |
| OperationProperties |
Propiedades de operación, incluyen especificaciones métricas. |
| OperationsListOptionalParams |
Parámetros opcionales. |
| OperationsOperations |
Interfaz que representa una operación de operaciones. |
| PageSettings |
Opciones para el método byPage |
| PagedAsyncIterableIterator |
Interfaz que permite la iteración asincrónica tanto a la finalización como a la página. |
| Permissions |
Permisos que la identidad tiene para claves, secretos, certificados y almacenamiento. |
| PrivateEndpoint |
Propiedades del objeto de punto de conexión privado. |
| PrivateEndpointConnection |
Recurso de conexión de punto de conexión privado. |
| PrivateEndpointConnectionItem |
Elemento de conexión de punto de conexión privado. |
| PrivateEndpointConnectionProperties |
Propiedades del recurso de conexión de punto final privado. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsGetOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsListByResourceOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsOperations |
Interfaz que representa una operación PrivateEndpointConnections. |
| PrivateEndpointConnectionsPutOptionalParams |
Parámetros opcionales. |
| PrivateLinkResource |
Un recurso de vínculo privado |
| PrivateLinkResourceListResult |
Lista de recursos de private link |
| PrivateLinkResourceProperties |
Propiedades de un recurso de vínculo privado. |
| PrivateLinkResourcesListByVaultOptionalParams |
Parámetros opcionales. |
| PrivateLinkResourcesOperations |
Interfaz que representa una operación PrivateLinkResources. |
| PrivateLinkServiceConnectionState |
Objeto que representa el estado de aprobación de la conexión de vínculo privado. |
| ProxyResource |
Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación |
| Resource |
Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager |
| RestorePollerOptions | |
| RotationPolicy |
interfaz de modelo Política de rotación |
| Secret |
Información de recursos con detalles extendidos. |
| SecretAttributes |
Atributos de administración de secretos. |
| SecretCreateOrUpdateParameters |
Parámetros para crear o actualizar un secreto |
| SecretPatchParameters |
Parámetros para aplicar revisiones a un secreto |
| SecretPatchProperties |
Propiedades del secreto |
| SecretProperties |
Propiedades del secreto |
| SecretsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| SecretsGetOptionalParams |
Parámetros opcionales. |
| SecretsListOptionalParams |
Parámetros opcionales. |
| SecretsOperations |
Interfaz que representa una operación de Secrets. |
| SecretsUpdateOptionalParams |
Parámetros opcionales. |
| ServiceSpecification |
Una propiedad de operación, incluye especificaciones de registro. |
| SimplePollerLike |
Un sondeo sencillo que se puede usar para sondear una operación de larga duración. |
| Sku |
Detalles de la SKU |
| SystemData |
Metadatos relativos a la creación y última modificación del recurso. |
| TrackedResource |
La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación". |
| Trigger |
Disparador de interfaz de modelo |
| UserAssignedIdentity |
Propiedades de identidad asignadas por el usuario |
| Vault |
Información de recursos con detalles extendidos. |
| VaultAccessPolicyParameters |
Parámetros para actualizar la directiva de acceso en un almacén |
| VaultAccessPolicyProperties |
Propiedades de la directiva de acceso del almacén |
| VaultCheckNameAvailabilityParameters |
Parámetros usados para comprobar la disponibilidad del nombre del almacén. |
| VaultCreateOrUpdateParameters |
Parámetros para crear o actualizar un almacén |
| VaultPatchParameters |
Parámetros para crear o actualizar un almacén |
| VaultPatchProperties |
Propiedades del almacén |
| VaultProperties |
Propiedades del almacén |
| VaultsCheckNameAvailabilityOptionalParams |
Parámetros opcionales. |
| VaultsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| VaultsDeleteOptionalParams |
Parámetros opcionales. |
| VaultsGetDeletedOptionalParams |
Parámetros opcionales. |
| VaultsGetOptionalParams |
Parámetros opcionales. |
| VaultsListByResourceGroupOptionalParams |
Parámetros opcionales. |
| VaultsListBySubscriptionOptionalParams |
Parámetros opcionales. |
| VaultsListDeletedOptionalParams |
Parámetros opcionales. |
| VaultsListOptionalParams |
Parámetros opcionales. |
| VaultsOperations |
Interfaz que representa operaciones de Vaults. |
| VaultsPurgeDeletedOptionalParams |
Parámetros opcionales. |
| VaultsUpdateAccessPolicyOptionalParams |
Parámetros opcionales. |
| VaultsUpdateOptionalParams |
Parámetros opcionales. |
| VirtualNetworkRule |
Una regla que rige la accesibilidad de un almacén desde una red virtual específica. |
Alias de tipos
| AccessPolicyUpdateKind |
Tipo de AccesoPolíticaActualizaciónTipo |
| ActionsRequired |
Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor. Valores conocidos admitidos por el servicioNinguno |
| ActivationStatus |
Estado de activación Valores conocidos admitidos por el servicio
Active: el grupo de HSM administrado está activo. |
| AzureSupportedClouds |
Los valores admitidos para la configuración de nube como un tipo literal de cadena |
| CertificatePermissions |
Tipo de Permisos de Certificado |
| ContinuablePage |
Interfaz que describe una página de resultados. |
| CreateMode |
Modo de creación del almacén para indicar si el almacén debe recuperarse o no. |
| CreatedByType |
Tipo de entidad que creó el recurso. Valores conocidos admitidos por el servicio
Usuario: un usuario creó la entidad. |
| DeletionRecoveryLevel |
El nivel de recuperación de eliminación actualmente en vigor para el objeto. Si contiene 'Purgable', entonces el objeto puede ser eliminado permanentemente por un usuario privilegiado; de lo contrario, solo el sistema puede purgar el objeto al final del intervalo de retención. Valores conocidos admitidos por el servicio
purgable |
| GeoReplicationRegionProvisioningState |
Estado de aprovisionamiento actual. Valores conocidos admitidos por el servicio
de aprovisionamiento previo |
| JsonWebKeyCurveName |
Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName. El predeterminado para las teclas EC y EC-HSM es P-256 Valores conocidos admitidos por el servicio
P-256 |
| JsonWebKeyOperation |
Las operaciones permitidas de la clave web JSON de la clave. Para más información, consulte JsonWebKeyOperation. Valores conocidos admitidos por el servicio
cifrar |
| JsonWebKeyType |
Tipo de la clave. Para obtener valores válidos, consulte JsonWebKeyType. Valores conocidos admitidos por el servicio
EC |
| KeyPermissions |
Tipo de permisos de clave |
| KeyRotationPolicyActionType |
Tipo de acción. |
| ManagedHsmSkuFamily |
Familia de SKU del pool HSM gestionado Valores conocidos admitidos por el servicio
B |
| ManagedHsmSkuName |
SKU del grupo de HSM administrado |
| ManagedServiceIdentityType |
Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned). Valores conocidos admitidos por el servicio
Ninguno: ninguna identidad administrada. |
| NetworkRuleAction |
Acción predeterminada cuando no hay ninguna regla de ipRules y de virtualNetworkRules coinciden. Esto solo se usa después de evaluar la propiedad bypass. Valores conocidos admitidos por el servicio
Permitir |
| NetworkRuleBypassOptions |
Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica el valor predeterminado es "AzureServices". Valores conocidos admitidos por el servicio
azureServices |
| PrivateEndpointConnectionProvisioningState |
Estado de aprovisionamiento actual. Valores conocidos admitidos por el servicio
correcto |
| PrivateEndpointServiceConnectionStatus |
Estado de conexión del punto de conexión privado. Valores conocidos admitidos por el servicio
pendiente |
| ProvisioningState |
Estado de aprovisionamiento. Valores conocidos admitidos por el servicio
correcto: el grupo de HSM administrado se ha aprovisionado por completo. |
| PublicNetworkAccess |
Controle el permiso para el HSM administrado desde redes públicas. Valores conocidos admitidos por el servicio
habilitado para |
| Reason |
La razón por la que no se pudo usar un nombre de almacén. El elemento Reason solo se devuelve si NameAvailable es false. Valores conocidos admitidos por el servicio
NombreDeCuentaInválido |
| SecretPermissions |
Tipo de permisos secretos |
| SkuFamily |
Apellido SKU Valores conocidos admitidos por el servicioA |
| SkuName |
Nombre de SKU para especificar si el almacén de claves es un almacén estándar o un almacén Premium. |
| StoragePermissions |
Tipo de permisos de almacenamiento |
| VaultProvisioningState |
Estado de aprovisionamiento del almacén. Valores conocidos admitidos por el servicio
correcto |
Enumeraciones
| AzureClouds |
Una enumeración para describir los entornos de la nube de Azure. |
| KnownActionsRequired |
Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor. |
| KnownActivationStatus |
Estado de activación |
| KnownCertificatePermissions |
Los valores conocidos de CertificatePermissions que acepta el servicio. |
| KnownCreatedByType |
Tipo de entidad que creó el recurso. |
| KnownDeletionRecoveryLevel |
El nivel de recuperación de eliminación actualmente en vigor para el objeto. Si contiene 'Purgable', entonces el objeto puede ser eliminado permanentemente por un usuario privilegiado; de lo contrario, solo el sistema puede purgar el objeto al final del intervalo de retención. |
| KnownGeoReplicationRegionProvisioningState |
Estado de aprovisionamiento actual. |
| KnownJsonWebKeyCurveName |
Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName. El valor predeterminado para las claves EC y EC-HSM es P-256 |
| KnownJsonWebKeyOperation |
Las operaciones permitidas de la clave web JSON de la clave. Para más información, consulte JsonWebKeyOperation. |
| KnownJsonWebKeyType |
Tipo de la clave. Para obtener valores válidos, consulte JsonWebKeyType. |
| KnownKeyPermissions |
Los valores conocidos de KeyPermissions que acepta el servicio. |
| KnownManagedHsmSkuFamily |
Familia de SKU del grupo de HSM administrado |
| KnownManagedServiceIdentityType |
Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned). |
| KnownNetworkRuleAction |
Acción predeterminada cuando no hay ninguna regla de ipRules y de virtualNetworkRules coinciden. Esto solo se usa después de evaluar la propiedad bypass. |
| KnownNetworkRuleBypassOptions |
Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica el valor predeterminado es "AzureServices". |
| KnownPrivateEndpointConnectionProvisioningState |
Estado de aprovisionamiento actual. |
| KnownPrivateEndpointServiceConnectionStatus |
Estado de conexión del punto de conexión privado. |
| KnownProvisioningState |
Estado de aprovisionamiento. |
| KnownPublicNetworkAccess |
Controle el permiso para el HSM administrado desde redes públicas. |
| KnownReason |
La razón por la que no se pudo usar un nombre de almacén. El elemento Reason solo se devuelve si NameAvailable es false. |
| KnownSecretPermissions |
Los valores conocidos de SecretPermissions que acepta el servicio. |
| KnownSkuFamily |
Nombre de familia de SKU |
| KnownStoragePermissions |
Los valores conocidos de StoragePermissions que acepta el servicio. |
| KnownVaultProvisioningState |
Estado de aprovisionamiento del almacén. |
| KnownVersions |
Las versiones de API disponibles. |
Funciones
| restore |
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito. |
Detalles de la función
restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.
function restorePoller<TResponse, TResult>(client: KeyVaultManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parámetros
- client
- KeyVaultManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Devoluciones
PollerLike<OperationState<TResult>, TResult>