Compartilhar via


@azure/keyvault-admin package

Classes

KeyVaultAccessControlClient

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

KeyVaultBackupClient

O KeyVaultBackupClient fornece métodos para gerar backups e restaurar backups de qualquer determinada instância do Azure Key Vault. Esse cliente dá suporte à geração de backups completos, restaurações seletivas de chaves específicas e restaurações completas de instâncias do Key Vault.

KeyVaultSettingsClient

O KeyVaultSettingsClient fornece métodos assíncronos para criar, atualizar, obter e listar configurações para o Azure Key Vault.

Interfaces

AccessControlClientOptions

Os parâmetros opcionais aceitos pelo AccessControlClient do Key Vault

BooleanKeyVaultSetting

Uma configuração do Key Vault do tipo booliano. Para verificar se um determinado KeyVaultSetting é um booliano, 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 do Administrador do Key Vault 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 Key Vault.

KeyVaultRestoreOperationState

Uma interface que representa as propriedades disponíveis publicamente do estado de uma operação de sondagem do Key Vault 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 Key Vault.

KeyVaultRoleAssignmentProperties

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

KeyVaultRoleDefinition

Uma definição de função do Key Vault.

KeyVaultSelectiveKeyRestoreOperationState

Uma interface que representa as propriedades disponíveis publicamente do estado de uma operação de sondagem do Key Vault de restauração.

KeyVaultSelectiveKeyRestoreResult

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

KeyVaultSetting

Uma configuração do Key Vault.

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 disponíveis publicamente do estado de uma operação de pesquisa do Key Vault de backup.

KeyVaultDataAction

Define valores para DataAction.
<xref:KnownDataAction> pode ser usado de forma intercambiável com DataAction, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Microsoft.KeyVault/managedHsm/keys/read/action: ler metadados de chave HSM.
Microsoft.KeyVault/managedHsm/keys/write/action: atualizar uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: chave HSM excluída de leitura.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: recuperar a chave HSM excluída.
Microsoft.KeyVault/managedHsm/keys/backup/action: backup de chaves HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action: Restaurar 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 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: Descriptografar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action: encapsular usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: desembrulhar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action: assinar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action: Verifique o uso de uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/create: Criar uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/delete: excluir uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/export/action: Exportar uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/release/action: libere uma chave HSM usando a Versão de Chave Segura.
Microsoft.KeyVault/managedHsm/keys/import/action: importar uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: limpar uma chave HSM excluída.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: baixe um domínio de segurança do 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: carregar um domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: verifique o status do arquivo de troca de domínio de segurança do 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 de HSM.
Microsoft.KeyVault/managedHsm/restore/start/action: iniciar uma restauração de HSM.
Microsoft.KeyVault/managedHsm/backup/status/action: ler 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

/: escopo global
/keys: escopo de chaves

SUPPORTED_API_VERSIONS

Versões de API com suporte

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 booliano.

Detalhes da função

isBooleanSetting(KeyVaultSetting)

Determina se um determinado KeyVaultSetting é um booleanKeyVaultSetting, ou seja, tem um valor booliano.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parâmetros

setting
KeyVaultSetting

Retornos

setting