Use-AipServiceKeyVaultKey
Informa a Proteção de Informações do Azure para usar uma chave de locatário gerenciada pelo cliente no Cofre de Chaves do Azure.
Sintaxe
Use-AipServiceKeyVaultKey
-KeyVaultKeyUrl <String>
[-FriendlyName <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
O cmdlet Use-AipServiceKeyVaultKey informa à Proteção de Informações do Azure para usar uma chave gerenciada pelo cliente (BYOK) no Cofre de Chaves do Azure.
Você deve usar o PowerShell para configurar sua chave de locatário; Não é possível fazer essa configuração usando um portal de gerenciamento.
Você pode executar esse cmdlet antes ou depois que o serviço de proteção (Azure Rights Management) for ativado.
Antes de executar este cmdlet, verifique se a entidade de serviço do Azure Rights Management recebeu permissões para o cofre de chaves que contém a chave que você deseja usar para a Proteção de Informações do Azure. Essas permissões são concedidas executando o cmdlet Azure Key Vault, Set-AzKeyVaultAccessPolicy.
Por motivos de segurança, o cmdlet
Para obter mais informações, consulte Práticas recomendadas para escolher o local do Cofre da Chave do Azure.
Observação
Se você executar esse cmdlet antes que as permissões sejam concedidas ao cofre de chaves, verá um erro exibido O serviço Rights Management falhou ao adicionar a chave.
Para ver informações mais detalhadas, execute o comando novamente, com -Verbose. Se as permissões não forem concedidas, você verá VERBOSE: Falha ao acessar o Azure KeyVault.
Quando o comando é executado com êxito, a chave é adicionada como uma chave de locatário gerenciada pelo cliente arquivada para a Proteção de Informações do Azure para sua organização. Para torná-la a chave de locatário ativa para a Proteção de Informações do Azure, você deve executar o cmdlet Set-AipServiceKeyProperties.
Use o Azure Key Vault para gerenciar e monitorar centralmente o uso da chave que você especificou. Todas as chamadas para sua chave de locatário serão feitas para o cofre de chaves que sua organização possui. Você pode confirmar qual chave está usando no Cofre da Chave usando o cmdlet Get-AipServiceKeys.
Para obter mais informações sobre os tipos de chaves de locatário que a Proteção de Informações do Azure suporta, consulte Planejando e implementando sua chave de locatário da Proteção de Informações do Azure.
Para obter mais informações sobre o Azure Key Vault, consulte O que é o Azure Key Vault.
Exemplos
Exemplo 1: Configurar a Proteção de Informações do Azure para usar uma chave gerenciada pelo cliente no Cofre de Chaves do Azure
PS C:\>Use-AipServiceKeyVaultKey -KeyVaultKeyUrl "https://contoso.vault.azure.net/keys/contoso-aipservice-key/aaaabbbbcccc111122223333"Este comando informa a Proteção de Informações do Azure para usar a chave chamada contoso-aipservice-key, versão aaaabbbbcccc111122223333, no cofre de chaves chamado contoso.
Essa chave e essa versão no Cofre de Chaves do Azure se tornam a chave de locatário gerenciada pelo cliente para a Proteção de Informações do Azure.
Parâmetros
-Confirm
Solicita confirmação antes de executar o cmdlet.
| Tipo: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Force
Força o comando a ser executado sem pedir a confirmação do usuário.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-FriendlyName
Especifica o nome amigável de um domínio de publicação confiável (TPD) e a chave SLC importada do AD RMS.
Se os usuários executarem o Office 2016 ou o Office 2013, especifique o mesmo valor de de nome
Este parâmetro é opcional. Se você não usá-lo, o identificador de chave será usado.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-KeyVaultKeyUrl
Especifica a URL da chave e da versão no Cofre da Chave do Azure que você deseja usar para sua chave de locatário.
Essa chave será usada pela Proteção de Informações do Azure como a chave raiz para todas as operações criptográficas para seu locatário.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
| Tipo: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |