Partilhar via


@azure/keyvault-admin package

Classes

KeyVaultAccessControlClient

O KeyVaultAccessControlClient fornece métodos para gerenciar o controle de acesso e as atribuições de função em qualquer instância do Azure Key Vault. O cliente suporta a criação, recuperação e exclusão de funções.

KeyVaultBackupClient

O KeyVaultBackupClient fornece métodos para gerar backups e restaurar backups de qualquer instância do Azure Key Vault. Este cliente suporta a geração de backups completos, restaurações seletivas de chaves específicas e restaurações completas de instâncias do Cofre de Chaves.

KeyVaultSettingsClient

O KeyVaultSettingsClient fornece métodos assíncronos para criar, atualizar, obter e listar configurações para o Cofre de Chaves do Azure.

Interfaces

AccessControlClientOptions

Os parâmetros opcionais aceitos pelo AccessControlClient do Key Vault

BooleanKeyVaultSetting

Uma configuração do Cofre da Chave do tipo booleano. Para verificar se um determinado KeyVaultSetting é um booleano, use isBooleanSetting.

CreateRoleAssignmentOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

DeleteRoleAssignmentOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

DeleteRoleDefinitionOptions

Uma interface que representa parâmetros opcionais passados para deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).

GetRoleAssignmentOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para getRoleAssignment(string, string, GetRoleAssignmentOptions)

GetRoleDefinitionOptions

Uma interface que representa parâmetros opcionais passados para getRoleDefinition(string, string, GetRoleDefinitionOptions).

GetSettingOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para getSetting

KeyVaultAdminPollOperationState

Uma interface que representa o estado da operação de um Key Vault Admin Poller.

KeyVaultBackupClientOptions

Os parâmetros opcionais aceitos pelo KeyVaultBackupClient

KeyVaultBackupPollerOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBackupResult

Uma interface que representa o resultado de uma operação de backup.

KeyVaultBeginBackupOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBeginRestoreOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para beginRestore(string, string, KeyVaultBeginRestoreOptions)

KeyVaultBeginSelectiveKeyRestoreOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

KeyVaultPermission

Uma lista de permissões do Cofre da Chave.

KeyVaultRestoreOperationState

Uma interface que representa as propriedades publicamente disponíveis do estado de uma operação de pesquisa do Cofre de Chaves de restauração.

KeyVaultRestoreResult

Uma interface que representa o resultado de uma operação de restauração.

KeyVaultRoleAssignment

Uma atribuição de função do Cofre de Chaves.

KeyVaultRoleAssignmentProperties

Propriedades de atribuição de função.

KeyVaultRoleDefinition

Uma definição de função do Cofre de Chaves.

KeyVaultSelectiveKeyRestoreOperationState

Uma interface que representa as propriedades publicamente disponíveis do estado de uma operação de pesquisa do Cofre de Chaves de restauração.

KeyVaultSelectiveKeyRestoreResult

Uma interface que representa o resultado de uma operação de restauração seletiva de chave.

KeyVaultSetting

Uma configuração do Cofre da Chave.

ListRoleAssignmentsOptions

Uma interface que representa parâmetros opcionais passados para listRoleAssignments(string, ListRoleAssignmentsOptions).

ListRoleAssignmentsPageSettings

Argumentos para recuperar a próxima página de resultados da pesquisa.

ListRoleDefinitionsOptions

Uma interface que representa parâmetros opcionais passados para listRoleDefinitions(string, ListRoleDefinitionsOptions).

ListRoleDefinitionsPageSettings

Argumentos para recuperar a próxima página de resultados da pesquisa.

ListSettingsOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para <xref:KeyVaultSettingsClient.listSettings>

ListSettingsResponse

Uma interface que representa a resposta retornada por <xref:KeyVaultSettingsClient.listSettings>

SetRoleDefinitionOptions

Uma interface que representa parâmetros opcionais passados para setRoleDefinition(string, SetRoleDefinitionOptions).

SettingsClientOptions

Os parâmetros opcionais aceitos pelo KeyVaultSettingsClient.

UpdateSettingOptions

Uma interface que representa os parâmetros opcionais que podem ser passados para updateSetting

Aliases de Tipo

KeyVaultBackupOperationState

Uma interface que representa as propriedades publicamente disponíveis do estado de uma operação de pesquisa do Cofre de Chaves de backup.

KeyVaultDataAction

Define valores para DataAction.
<xref:KnownDataAction> pode ser usado de forma intercambiável com DataAction, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Microsoft.KeyVault/managedHsm/keys/read/action: Leia os metadados da chave HSM.
Microsoft.KeyVault/managedHsm/keys/write/action: Atualize uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: Ler chave HSM excluída.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Recuperar chave HSM excluída.
Microsoft.KeyVault/managedHsm/keys/backup/action: Backup de chaves HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action: Restaure chaves HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Excluir atribuição de função.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Obter atribuição de função.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Criar ou atualizar a atribuição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Obter definição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Criar ou atualizar a definição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Excluir definição de função.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: Criptografar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: Desencriptar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action: Encapsular usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: Desembrulhe usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action: Assinar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action: Verifique usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/create: Crie uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/delete: Exclua uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/export/action: Exporte uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/release/action: libere uma chave HSM usando o Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action: Importe uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: Limpe uma chave HSM excluída.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: Baixe um domínio de segurança HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: Verifique o status do download do domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action: Carregue um domínio de segurança HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: Verifique o status do arquivo de troca de domínio de segurança HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: Baixe uma chave de transferência de domínio de segurança HSM.
Microsoft.KeyVault/managedHsm/backup/start/action: Inicie um backup do HSM.
Microsoft.KeyVault/managedHsm/restore/start/action: Inicie uma restauração do HSM.
Microsoft.KeyVault/managedHsm/backup/status/action: Leia um status de backup do HSM.
Microsoft.KeyVault/managedHsm/restore/status/action: Leia um status de restauração do HSM.
Microsoft.KeyVault/managedHsm/rng/action: Gerar números aleatórios.

KeyVaultRoleScope

Define valores para RoleScope.
<xref:KnownRoleScope> pode ser usado de forma intercambiável com RoleScope, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

/: Âmbito global
/keys: Escopo das chaves

SUPPORTED_API_VERSIONS

Versões de API suportadas

Enumerações

KnownKeyVaultDataAction

Valores conhecidos de KeyVaultDataAction que o serviço aceita.

KnownKeyVaultRoleScope

Valores conhecidos de KeyVaultRoleScope que o serviço aceita.

Funções

isBooleanSetting(KeyVaultSetting)

Determina se um determinado KeyVaultSetting é um BooleanKeyVaultSetting, ou seja, tem um valor booleano.

Detalhes de Função

isBooleanSetting(KeyVaultSetting)

Determina se um determinado KeyVaultSetting é um BooleanKeyVaultSetting, ou seja, tem um valor booleano.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parâmetros

setting
KeyVaultSetting

Devoluções

setting