@azure/arm-keyvault package
Classes
| KeyVaultManagementClient |
Interfaces
| AccessPolicyEntry |
Uma identidade que tem acesso ao cofre de chaves. Todas as identidades na matriz devem usar a mesma ID de locatário que a ID do 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 do Key Vault |
| CloudErrorBody |
Uma resposta de erro do provedor de recursos do Key Vault |
| DeletedManagedHsm |
Tipos de recursos de proxy concretos podem ser criados com o alias desse 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 de um endereço IP específico ou intervalo de ip. |
| Key |
O recurso de chave. |
| KeyAttributes |
Os atributos de objeto gerenciados pelo serviço do Azure Key Vault. |
| KeyCreateParameters |
Os parâmetros usados para criar uma chave. |
| KeyProperties |
As propriedades da chave. |
| KeyReleasePolicy |
interface de modelo KeyReleasePolicy |
| KeyRotationPolicyAttributes |
interface de 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 de modelo LifetimeAction |
| LogSpecification |
Especificação de log da operação. |
| ManagedHSMSecurityDomainProperties |
As propriedades de domínio de segurança do hsm gerenciado. |
| ManagedHsm |
Informações de recurso com detalhes estendidos. |
| ManagedHsmAction |
interface de modelo ManagedHsmAction |
| ManagedHsmError |
A exceção de erro. |
| ManagedHsmKey |
O recurso de chave. |
| ManagedHsmKeyAttributes |
Os atributos de objeto gerenciados pelo serviço do Azure Key Vault. |
| ManagedHsmKeyCreateParameters |
Os parâmetros usados para criar uma chave. |
| ManagedHsmKeyProperties |
As propriedades da chave. |
| ManagedHsmKeyReleasePolicy |
interface de modelo ManagedHsmKeyReleasePolicy |
| ManagedHsmKeyRotationPolicyAttributes |
interface de modelo GerenciadoHsmChaveRotaçãoPolíticaAtributos |
| ManagedHsmKeysCreateIfNotExistOptionalParams |
Parâmetros opcionais. |
| ManagedHsmKeysGetOptionalParams |
Parâmetros opcionais. |
| ManagedHsmKeysGetVersionOptionalParams |
Parâmetros opcionais. |
| ManagedHsmKeysListOptionalParams |
Parâmetros opcionais. |
| ManagedHsmKeysListVersionsOptionalParams |
Parâmetros opcionais. |
| ManagedHsmKeysOperations |
Interface representando operações ManagedHsmKeys. |
| ManagedHsmLifetimeAction |
interface de modelo ManagedHsmLifetimeAction |
| ManagedHsmProperties |
Propriedades do pool de HSM gerenciado |
| ManagedHsmRotationPolicy |
interface de modelo GerenciadaHsmRotationPolicy |
| ManagedHsmSku |
Detalhes da SKU |
| ManagedHsmTrigger |
interface de modelo GerenciadoHsmTrigger |
| 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 de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário) |
| MetricSpecification |
Especificação de métrica da 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 de hsm gerenciado. |
| MhsmPrivateEndpoint |
Propriedades de 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 conexão do 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 operações MhsmRegions. |
| MhsmServiceTagRule |
Uma regra que regula a acessibilidade de um pool de HSM gerenciado a partir de tags de serviço específicas. |
| MhsmVirtualNetworkRule |
Uma regra que rege a acessibilidade de um pool de hsm gerenciado de uma rede virtual específica. |
| MhsmipRule |
Uma regra que rege a acessibilidade de um pool de HSM gerenciado de um endereço IP específico ou intervalo de IP. |
| NetworkRuleSet |
Um conjunto de regras que regem a acessibilidade de rede de um cofre. |
| Operation |
Definição da operação da API REST do Key Vault. |
| OperationDisplay |
Exibir metadados associados à operação. |
| OperationProperties |
As propriedades de operação incluem especificações métricas. |
| OperationsListOptionalParams |
Parâmetros opcionais. |
| OperationsOperations |
Interface que representa operações de operações. |
| PageSettings |
Opções para o método byPage |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página. |
| Permissions |
Permissões que a identidade tem para chaves, segredos, certificados e armazenamento. |
| PrivateEndpoint |
Propriedades de 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 conexão do 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 do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas 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 recurso com detalhes estendidos. |
| SecretAttributes |
Os atributos de gerenciamento de segredo. |
| SecretCreateOrUpdateParameters |
Parâmetros para criar ou atualizar um segredo |
| SecretPatchParameters |
Parâmetros para aplicação de patch de 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 Secrets. |
| SecretsUpdateOptionalParams |
Parâmetros opcionais. |
| ServiceSpecification |
Uma propriedade da operação, inclua especificações de log. |
| SimplePollerLike |
Um sondador simples que pode ser usado para sondar uma operação de longa execução. |
| Sku |
Detalhes da SKU |
| SystemData |
Metadados relativos à criação e última modificação do recurso. |
| TrackedResource |
A definição do modelo de recurso para um recurso de nível superior rastreado pelo Azure Resource Manager que tem 'marcas' e um 'local' |
| Trigger |
Interface do modelo Trigger |
| UserAssignedIdentity |
Propriedades de identidade atribuídas pelo usuário |
| Vault |
Informações de recurso com detalhes estendidos. |
| VaultAccessPolicyParameters |
Parâmetros para atualizar a política de acesso em um cofre |
| VaultAccessPolicyProperties |
Propriedades da política de acesso do 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 de uma rede virtual específica. |
Aliases de tipo
| AccessPolicyUpdateKind |
Tipo de AcessoPolíticaAtualizarTipo |
| ActionsRequired |
Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor. Valores conhecidos compatíveis com o serviçoNenhum |
| ActivationStatus |
Status de Ativação Valores conhecidos compatíveis com o serviço
Active: o pool de HSM gerenciado está ativo. |
| AzureSupportedClouds |
Os valores com suporte 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. Valores conhecidos compatíveis com o serviço
User: a entidade foi criada por um usuário. |
| DeletionRecoveryLevel |
O nível de recuperação de exclusão atualmente em vigor para o objeto. Se ele contiver 'Purgeable', então o objeto pode ser permanentemente excluído por um usuário privilegiado; caso contrário, somente o sistema pode purgar o objeto ao final do intervalo de retenção. Valores conhecidos compatíveis com o serviço
purgável |
| GeoReplicationRegionProvisioningState |
O estado de provisionamento atual. Valores conhecidos compatíveis com o serviço
pré-provisionamento |
| JsonWebKeyCurveName |
O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. O padrão para as teclas EC e EC-HSM é P-256 Valores conhecidos compatíveis com o serviço
P-256 |
| JsonWebKeyOperation |
As operações permitidas da chave web JSON da chave. Para obter mais informações, consulte JsonWebKeyOperation. Valores conhecidos compatíveis com o serviço
criptografar |
| JsonWebKeyType |
O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. Valores conhecidos compatíveis com o serviço
de EC |
| KeyPermissions |
Tipo de Permissões de Chave |
| KeyRotationPolicyActionType |
O tipo de ação. |
| ManagedHsmSkuFamily |
Família de SKUs do Pool HSM gerenciado Valores conhecidos compatíveis com o serviço
B |
| ManagedHsmSkuName |
SKU do pool de HSM gerenciado |
| ManagedServiceIdentityType |
Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos). Valores conhecidos compatíveis com o serviço
Nenhum: nenhuma 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 é avaliada. Valores conhecidos compatíveis com o serviço
Permitir |
| NetworkRuleBypassOptions |
Informa o que o tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'. Valores conhecidos compatíveis com o serviço
do AzureServices |
| PrivateEndpointConnectionProvisioningState |
O estado de provisionamento atual. Valores conhecidos compatíveis com o serviço
êxito |
| PrivateEndpointServiceConnectionStatus |
O status da conexão do ponto de extremidade privado. Valores conhecidos compatíveis com o serviço
pendente |
| ProvisioningState |
Estado de provisionamento. Valores conhecidos compatíveis com o serviço
bem-sucedido: o pool de HSM gerenciado foi provisionado por completo. |
| PublicNetworkAccess |
Controle a permissão para o HSM gerenciado de redes públicas. Valores conhecidos compatíveis com o serviço
habilitado |
| 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. Valores conhecidos compatíveis com o serviço
NomeDeContaInválido |
| SecretPermissions |
Tipo de Permissões Secretas |
| SkuFamily |
Sobrenome SKU Valores conhecidos compatíveis com o serviçoum |
| SkuName |
Nome da SKU para especificar se o cofre de chaves é um cofre padrão ou um cofre Premium. |
| StoragePermissions |
Tipo de Permissões de Armazenamento |
| VaultProvisioningState |
Estado de provisionamento do cofre. Valores conhecidos compatíveis com o serviço
êxito |
Enumerações
| AzureClouds |
Um enumeração para descrever os ambientes de nuvem do Azure. |
| KnownActionsRequired |
Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor. |
| KnownActivationStatus |
Status de ativação |
| KnownCertificatePermissions |
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 exclusão atualmente em vigor para o objeto. Se ele contiver 'Purgeable', então o objeto pode ser permanentemente excluído por um usuário privilegiado; caso contrário, somente o sistema pode purgar o objeto ao final do intervalo de retenção. |
| KnownGeoReplicationRegionProvisioningState |
O estado de provisionamento atual. |
| KnownJsonWebKeyCurveName |
O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. O padrão para 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 obter valores válidos, consulte JsonWebKeyType. |
| KnownKeyPermissions |
Valores conhecidos de KeyPermissions que o serviço aceita. |
| KnownManagedHsmSkuFamily |
Família de SKU do pool de HSM gerenciado |
| KnownManagedServiceIdentityType |
Tipo de identidade de serviço gerenciado (em que 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 é avaliada. |
| KnownNetworkRuleBypassOptions |
Informa o que o 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 do ponto de extremidade privado. |
| KnownProvisioningState |
Estado de provisionamento. |
| KnownPublicNetworkAccess |
Controle a permissão para o HSM gerenciado 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 |
Valores conhecidos de SecretPermissions que o serviço aceita. |
| KnownSkuFamily |
Nome da família SKU |
| KnownStoragePermissions |
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
| restore |
Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo. |
Detalhes da função
restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver 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>
Retornos
PollerLike<OperationState<TResult>, TResult>