@azure/arm-keyvault package

Classes

KeyVaultManagementClient

Interfaces

AccessPolicyEntry	Uma identidade que tem acesso ao cofre de chaves. Todas as identidades na matriz devem usar o mesmo ID de locatário que o ID de locatário do cofre de chaves.
Action	Ação da interface do modelo
Attributes	Os atributos de objeto gerenciados pelo serviço KeyVault.
CheckMhsmNameAvailabilityParameters	Os parâmetros usados para verificar a disponibilidade do nome hsm gerenciado.
CheckMhsmNameAvailabilityResult	A resposta da operação CheckMhsmNameAvailability.
CheckNameAvailabilityResult	A resposta da operação CheckNameAvailability.
CloudError	Uma resposta de erro do provedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault
DeletedManagedHsm	Tipos de recursos de proxy concretos podem ser criados aliando esse tipo usando um tipo de propriedade específico.
DeletedManagedHsmProperties	Propriedades do HSM gerenciado excluído.
DeletedVault	Informações do cofre excluídas com detalhes estendidos.
DeletedVaultProperties	Propriedades do cofre excluído.
DimensionProperties	Tipo de operação: obter, ler, excluir, etc.
ErrorModel	O erro do servidor.
IPRule	Uma regra que rege a acessibilidade de um cofre a partir de um endereço IP ou intervalo de ip específico.
Key	O recurso-chave.
KeyAttributes	Os atributos de objeto gerenciados pelo serviço Azure Key Vault.
KeyCreateParameters	Os parâmetros usados para criar uma chave.
KeyProperties	As propriedades da chave.
KeyReleasePolicy	interface do modelo KeyReleasePolicy
KeyRotationPolicyAttributes	interface do modelo KeyRotationPolicyAttributes
KeyVaultManagementClientOptionalParams	Parâmetros opcionais para o cliente.
KeysCreateIfNotExistOptionalParams	Parâmetros opcionais.
KeysGetOptionalParams	Parâmetros opcionais.
KeysGetVersionOptionalParams	Parâmetros opcionais.
KeysListOptionalParams	Parâmetros opcionais.
KeysListVersionsOptionalParams	Parâmetros opcionais.
KeysOperations	Interface representando operações de chaves.
LifetimeAction	interface do modelo LifetimeAction
LogSpecification	Log especificação de operação.
ManagedHSMSecurityDomainProperties	As propriedades do domínio de segurança do hsm gerenciado.
ManagedHsm	Informações de recursos com detalhes estendidos.
ManagedHsmAction	interface de modelo ManagedHsmAction
ManagedHsmError	A exceção de erro.
ManagedHsmKey	O recurso-chave.
ManagedHsmKeyAttributes	Os atributos de objeto gerenciados pelo serviço Azure Key Vault.
ManagedHsmKeyCreateParameters	Os parâmetros usados para criar uma chave.
ManagedHsmKeyProperties	As propriedades da chave.
ManagedHsmKeyReleasePolicy	interface modelo ManagedHsmKeyReleasePolicy
ManagedHsmKeyRotationPolicyAttributes	interface de modelo ManagedHsmKeyRotationPolicyAttributes
ManagedHsmKeysCreateIfNotExistOptionalParams	Parâmetros opcionais.
ManagedHsmKeysGetOptionalParams	Parâmetros opcionais.
ManagedHsmKeysGetVersionOptionalParams	Parâmetros opcionais.
ManagedHsmKeysListOptionalParams	Parâmetros opcionais.
ManagedHsmKeysListVersionsOptionalParams	Parâmetros opcionais.
ManagedHsmKeysOperations	Interface representando uma operação ManagedHsmKeys.
ManagedHsmLifetimeAction	interface de modelo GeridaHsmLifetimeAction
ManagedHsmProperties	Propriedades do pool de HSM gerenciado
ManagedHsmRotationPolicy	interface de modelo ManagedHsmRotationPolicy
ManagedHsmSku	Detalhes do SKU
ManagedHsmTrigger	interface modelo ManagedHsmTrigger
ManagedHsmsCheckMhsmNameAvailabilityOptionalParams	Parâmetros opcionais.
ManagedHsmsCreateOrUpdateOptionalParams	Parâmetros opcionais.
ManagedHsmsDeleteOptionalParams	Parâmetros opcionais.
ManagedHsmsGetDeletedOptionalParams	Parâmetros opcionais.
ManagedHsmsGetOptionalParams	Parâmetros opcionais.
ManagedHsmsListByResourceGroupOptionalParams	Parâmetros opcionais.
ManagedHsmsListBySubscriptionOptionalParams	Parâmetros opcionais.
ManagedHsmsListDeletedOptionalParams	Parâmetros opcionais.
ManagedHsmsOperations	Interface representando uma operação ManagedHsms.
ManagedHsmsPurgeDeletedOptionalParams	Parâmetros opcionais.
ManagedHsmsUpdateOptionalParams	Parâmetros opcionais.
ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
MetricSpecification	Especificação métrica de operação.
MhsmGeoReplicatedRegion	Uma região para a qual esse Pool de HSM gerenciado foi estendido.
MhsmNetworkRuleSet	Um conjunto de regras que regem a acessibilidade de rede de um pool hsm gerenciado.
MhsmPrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
MhsmPrivateEndpointConnection	Recurso de conexão de ponto de extremidade privado.
MhsmPrivateEndpointConnectionItem	Item de conexão de ponto de extremidade privado.
MhsmPrivateEndpointConnectionProperties	Propriedades do recurso de ligação ao endpoint privado.
MhsmPrivateEndpointConnectionsDeleteOptionalParams	Parâmetros opcionais.
MhsmPrivateEndpointConnectionsGetOptionalParams	Parâmetros opcionais.
MhsmPrivateEndpointConnectionsListByResourceOptionalParams	Parâmetros opcionais.
MhsmPrivateEndpointConnectionsOperations	Interface representando operações MhsmPrivateEndpointConnections.
MhsmPrivateEndpointConnectionsPutOptionalParams	Parâmetros opcionais.
MhsmPrivateLinkResource	Um recurso de link privado
MhsmPrivateLinkResourceListResult	Uma lista de recursos de link privado
MhsmPrivateLinkResourceProperties	Propriedades de um recurso de link privado.
MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams	Parâmetros opcionais.
MhsmPrivateLinkResourcesOperations	Interface representando uma operação MhsmPrivateLinkResources.
MhsmPrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da conexão de link privado.
MhsmRegionsListByResourceOptionalParams	Parâmetros opcionais.
MhsmRegionsOperations	Interface representando uma operação MhsmRegions.
MhsmServiceTagRule	Uma regra que regula a acessibilidade de um pool de HSM gerido a partir de etiquetas de serviço específicas.
MhsmVirtualNetworkRule	Uma regra que rege a acessibilidade de um pool hsm gerenciado a partir de uma rede virtual específica.
MhsmipRule	Uma regra que rege a acessibilidade de um pool de HSM gerenciado a partir de um endereço IP ou intervalo de IP específico.
NetworkRuleSet	Um conjunto de regras que regem a acessibilidade de rede de um cofre.
Operation	Definição de operação da API REST do Key Vault.
OperationDisplay	Exibir metadados associados à operação.
OperationProperties	Propriedades de operação, incluem especificações métricas.
OperationsListOptionalParams	Parâmetros opcionais.
OperationsOperations	Interface que representa uma operação de Operações.
PageSettings	Opções para o método byPage
PagedAsyncIterableIterator	Uma interface que permite iteração assíncrona iterável até a conclusão e por página.
Permissions	Permissões que a identidade tem para chaves, segredos, certificados e armazenamento.
PrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
PrivateEndpointConnection	Recurso de conexão de ponto de extremidade privado.
PrivateEndpointConnectionItem	Item de conexão de ponto de extremidade privado.
PrivateEndpointConnectionProperties	Propriedades do recurso de ligação ao endpoint privado.
PrivateEndpointConnectionsDeleteOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsGetOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsListByResourceOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsOperations	Interface que representa uma operação PrivateEndpointConnections.
PrivateEndpointConnectionsPutOptionalParams	Parâmetros opcionais.
PrivateLinkResource	Um recurso de link privado
PrivateLinkResourceListResult	Uma lista de recursos de link privado
PrivateLinkResourceProperties	Propriedades de um recurso de link privado.
PrivateLinkResourcesListByVaultOptionalParams	Parâmetros opcionais.
PrivateLinkResourcesOperations	Interface que representa uma operação PrivateLinkResources.
PrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da conexão de link privado.
ProxyResource	A definição de modelo de recurso para um recurso de proxy do Azure Resource Manager. Ele não terá tags e um local
Resource	Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager
RestorePollerOptions
RotationPolicy	interface de modelo RotationPolicy
Secret	Informações de recursos com detalhes estendidos.
SecretAttributes	Os atributos de gerenciamento secreto.
SecretCreateOrUpdateParameters	Parâmetros para criar ou atualizar um segredo
SecretPatchParameters	Parâmetros para corrigir um segredo
SecretPatchProperties	Propriedades do segredo
SecretProperties	Propriedades do segredo
SecretsCreateOrUpdateOptionalParams	Parâmetros opcionais.
SecretsGetOptionalParams	Parâmetros opcionais.
SecretsListOptionalParams	Parâmetros opcionais.
SecretsOperations	Interface representando uma operação de Secrets.
SecretsUpdateOptionalParams	Parâmetros opcionais.
ServiceSpecification	Uma propriedade de operação, incluem especificações de log.
SimplePollerLike	Um poller simples que pode ser usado para sondar uma operação de longa duração.
Sku	Detalhes do SKU
SystemData	Metadados referentes à criação e última modificação do recurso.
TrackedResource	A definição do modelo de recursos para um recurso de nível superior rastreado do Azure Resource Manager que tem 'tags' e um 'local'
Trigger	Interface do modelo Trigger
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário
Vault	Informações de recursos com detalhes estendidos.
VaultAccessPolicyParameters	Parâmetros para atualizar a política de acesso em um cofre
VaultAccessPolicyProperties	Propriedades da política de acesso ao cofre
VaultCheckNameAvailabilityParameters	Os parâmetros usados para verificar a disponibilidade do nome do cofre.
VaultCreateOrUpdateParameters	Parâmetros para criar ou atualizar um cofre
VaultPatchParameters	Parâmetros para criar ou atualizar um cofre
VaultPatchProperties	Propriedades do cofre
VaultProperties	Propriedades do cofre
VaultsCheckNameAvailabilityOptionalParams	Parâmetros opcionais.
VaultsCreateOrUpdateOptionalParams	Parâmetros opcionais.
VaultsDeleteOptionalParams	Parâmetros opcionais.
VaultsGetDeletedOptionalParams	Parâmetros opcionais.
VaultsGetOptionalParams	Parâmetros opcionais.
VaultsListByResourceGroupOptionalParams	Parâmetros opcionais.
VaultsListBySubscriptionOptionalParams	Parâmetros opcionais.
VaultsListDeletedOptionalParams	Parâmetros opcionais.
VaultsListOptionalParams	Parâmetros opcionais.
VaultsOperations	Interface que representa uma operação do Vaults.
VaultsPurgeDeletedOptionalParams	Parâmetros opcionais.
VaultsUpdateAccessPolicyOptionalParams	Parâmetros opcionais.
VaultsUpdateOptionalParams	Parâmetros opcionais.
VirtualNetworkRule	Uma regra que rege a acessibilidade de um cofre a partir de uma rede virtual específica.

Aliases de Tipo

AccessPolicyUpdateKind	Tipo de AccessPolicyUpdateKind
ActionsRequired	Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor. KnownActionsRequired pode ser usado de forma intercambiável com ActionsRequired, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Nenhum
ActivationStatus	Estado de Ativação KnownActivationStatus pode ser usado de forma intercambiável com ActivationStatus, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Ative: O Pool HSM gerenciado está ativo. NotActivated: O Pool HSM gerenciado ainda não está ativado. desconhecido: Ocorreu um erro desconhecido ao ativar o hsm gerenciado. Falha: Falha ao ativar o hsm gerenciado.
AzureSupportedClouds	Os valores suportados para a configuração de nuvem como um tipo literal de cadeia de caracteres
CertificatePermissions	Tipo de Permissões de Certificado
ContinuablePage	Uma interface que descreve uma página de resultados.
CreateMode	O modo de criação do cofre para indicar se o cofre precisa ser recuperado ou não.
CreatedByType	O tipo de entidade que criou o recurso. KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço User: A entidade foi criada por um usuário. Application: A entidade foi criada por um aplicativo. ManagedIdentity: A entidade foi criada por uma identidade gerenciada. Key: A entidade foi criada por uma chave.
DeletionRecoveryLevel	O nível de recuperação de eliminação atualmente em vigor para o objeto. Se contiver 'Purgável', então o objeto pode ser eliminado permanentemente por um utilizador privilegiado; caso contrário, só o sistema pode purgar o objeto no final do intervalo de retenção. KnownDeletionRecoveryLevel pode ser usado de forma intercambiável com DeletionRecoveryLevel, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Expurgável recuperável+purgável recuperável Recoverable+ProtectedSubscription
GeoReplicationRegionProvisioningState	O estado de provisionamento atual. KnownGeoReplicationRegionProvisioningState puder ser usado de forma intercambiável com GeoReplicationRegionProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço de pré-provisionamento de provisionamento Sucedeu Falhou Excluindo Limpeza
JsonWebKeyCurveName	O nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName. O padrão para as teclas EC e EC-HSM é P-256 KnownJsonWebKeyCurveName pode ser usado de forma intercambiável com JsonWebKeyCurveName, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço P-256 P-384 P-521 P-256K
JsonWebKeyOperation	As operações permitidas da chave web JSON da chave. Para obter mais informações, consulte JsonWebKeyOperation. KnownJsonWebKeyOperation pode ser usado de forma intercambiável com JsonWebKeyOperation, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço criptografar desencriptar assinar verificar wrapKey unwrapKey importar lançamento
JsonWebKeyType	O tipo da chave. Para valores válidos, consulte JsonWebKeyType. KnownJsonWebKeyType pode ser usado de forma intercambiável com JsonWebKeyType, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço CE EC-HSM RSA RSA-HSM
KeyPermissions	Tipo de Permissões de Chave
KeyRotationPolicyActionType	O tipo de ação.
ManagedHsmSkuFamily	Família de SKUs do Pool HSM gerido KnownManagedHsmSkuFamily pode ser usado de forma intercambiável com ManagedHsmSkuFamily, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço B C
ManagedHsmSkuName	SKU do pool de HSM gerenciado
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). KnownManagedServiceIdentityType pode ser usado de forma intercambiável com ManagedServiceIdentityType, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Nenhum: Nenhuma identidade gerenciada. SystemAssigned: Identidade gerenciada atribuída ao sistema. UserAssigned: Identidade gerenciada atribuída pelo usuário. SystemAssigned,UserAssigned: Sistema e usuário atribuído identidade gerenciada.
NetworkRuleAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass foi avaliada. KnownNetworkRuleAction pode ser usado de forma intercambiável com NetworkRuleAction, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Permitir Negar
NetworkRuleBypassOptions	Informa qual tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'. KnownNetworkRuleBypassOptions pode ser usado de forma intercambiável com NetworkRuleBypassOptions, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço AzureServices Nenhum
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual. KnownPrivateEndpointConnectionProvisioningState pode ser usado de forma intercambiável com PrivateEndpointConnectionProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Sucedeu Criação de Atualização Excluindo Falhou Desconectado
PrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado. KnownPrivateEndpointServiceConnectionStatus pode ser usado de forma intercambiável com PrivateEndpointServiceConnectionStatus, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço pendente Aprovado Rejeitado Desconectado
ProvisioningState	Estado de provisionamento. KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço bem-sucedido: O pool de HSM gerenciado foi provisionado totalmente. de provisionamento: O pool de HSM gerenciado está sendo provisionado no momento. Falha: Falha no provisionamento do pool de HSM gerenciado. Atualizando: O pool de HSM gerenciado está sendo atualizado no momento. Excluindo: O pool HSM gerenciado está sendo excluído no momento. ativado : O pool de HSM gerenciado está pronto para uso normal. SecurityDomainRestore: O pool de HSM gerenciado está aguardando uma ação de restauração de domínio de segurança. Restaurando: O pool de HSM gerenciado está sendo restaurado a partir do backup completo do HSM.
PublicNetworkAccess	Controle a permissão para o HSM gerenciado a partir de redes públicas. KnownPublicNetworkAccess pode ser usado de forma intercambiável com PublicNetworkAccess, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço ativado Deficientes
Reason	O motivo pelo qual um nome de cofre não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false. KnownReason pode ser usado de forma intercambiável com Reason, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço NomeDeContaInválido já existe
SecretPermissions	Tipo de Permissões Secretas
SkuFamily	Apelido SKU KnownSkuFamily pode ser usado de forma intercambiável com SkuFamily, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço UM
SkuName	Nome da SKU para especificar se o cofre de chaves é um cofre padrão ou um cofre premium.
StoragePermissions	Tipo de StoragePermissions
VaultProvisioningState	Estado de provisionamento do cofre. KnownVaultProvisioningState pode ser usado de forma intercambiável com VaultProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Sucedeu RegisteringDns

Enumerações

AzureClouds	Um enum para descrever ambientes de nuvem do Azure.
KnownActionsRequired	Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor.
KnownActivationStatus	Status da ativação
KnownCertificatePermissions	Os valores conhecidos de CertificatePermissions que o serviço aceita.
KnownCreatedByType	O tipo de entidade que criou o recurso.
KnownDeletionRecoveryLevel	O nível de recuperação de eliminação atualmente em vigor para o objeto. Se contiver 'Purgável', então o objeto pode ser eliminado permanentemente por um utilizador privilegiado; caso contrário, só o sistema pode purgar o objeto no final do intervalo de retenção.
KnownGeoReplicationRegionProvisioningState	O estado de provisionamento atual.
KnownJsonWebKeyCurveName	O nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName. O padrão para as chaves EC e EC-HSM é P-256
KnownJsonWebKeyOperation	As operações permitidas da chave web JSON da chave. Para obter mais informações, consulte JsonWebKeyOperation.
KnownJsonWebKeyType	O tipo da chave. Para valores válidos, consulte JsonWebKeyType.
KnownKeyPermissions	Os valores conhecidos de KeyPermissions que o serviço aceita.
KnownManagedHsmSkuFamily	Família SKU do pool HSM gerenciado
KnownManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
KnownNetworkRuleAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass foi avaliada.
KnownNetworkRuleBypassOptions	Informa qual tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'.
KnownPrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
KnownPrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado.
KnownProvisioningState	Estado de provisionamento.
KnownPublicNetworkAccess	Controle a permissão para o HSM gerenciado a partir de redes públicas.
KnownReason	O motivo pelo qual um nome de cofre não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.
KnownSecretPermissions	Os valores conhecidos de SecretPermissions que o serviço aceita.
KnownSkuFamily	Nome de família SKU
KnownStoragePermissions	Os valores conhecidos de StoragePermissions que o serviço aceita.
KnownVaultProvisioningState	Estado de provisionamento do cofre.
KnownVersions	As versões de API disponíveis.

Funções

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Detalhes de Função

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

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>

Devoluções

PollerLike<OperationState<TResult>, TResult>