Use-AipServiceKeyVaultKey
Informa à Proteção de Informações do Azure para usar uma chave de locatário gerenciada pelo cliente no Azure Key Vault.
Sintaxe
Default (Padrão)
Use-AipServiceKeyVaultKey
-KeyVaultKeyUrl <String>
[-FriendlyName <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Use-AipServiceKeyVaultKey do
Você deve usar o PowerShell para configurar sua chave de locatário; você não pode 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 esse 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 do Azure Key Vault, Set-AzKeyVaultAccessPolicy.
Por motivos de segurança, o cmdlet Use-AipServiceKeyVaultKey não permite que você defina ou altere o controle de acesso para a chave no Azure Key Vault. Depois que esse acesso for concedido executando Set-AzKeyVaultAccessPolicy, execute Use-AipServiceKeyVaultKey para informar à Proteção de Informações do Azure para usar a chave e a versão especificadas com o parâmetro KeyVaultKeyUrl.
Para obter mais informações, consulte Práticas recomendadas para escolher o local do Azure Key Vault.
Observação
Se você executar esse cmdlet antes que as permissões sejam concedidas ao cofre de chaves, verá um erro que exibe 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 especificada. Todas as chamadas para sua chave de locatário serão feitas no cofre de chaves que sua organização possui. Você pode confirmar qual chave você está usando no Key Vault usando o cmdlet Get-AipServiceKeys.
Para obter mais informações sobre os tipos de chaves de locatário compatíveis com a Proteção de Informações do Azure, consulte Planejamento e implementação da 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 Azure Key Vault
PS C:\>Use-AipServiceKeyVaultKey -KeyVaultKeyUrl "https://contoso.vault.azure.net/keys/contoso-aipservice-key/aaaabbbbcccc111122223333"
Esse comando informa à Proteção de Informações do Azure para usar a chave chamada contoso-aipservice-key, versão aaaabbbbcccc11112222233333, no cofre de chaves denominado contoso.
Essa chave e versão no Azure Key Vault se tornam a chave de locatário gerenciada pelo cliente para a Proteção de Informações do Azure.
Parâmetros
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Force
Força o comando a ser executado sem solicitar a confirmação do usuário.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-FriendlyName
Especifica o nome amigável de um TPD (domínio de publicação confiável) e a chave SLC que você importou do AD RMS.
Se os usuários executarem o Office 2016 ou o Office 2013, especifique o mesmo nome amigável
Esse parâmetro é opcional. Se você não usá-lo, o identificador de chave será usado.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-KeyVaultKeyUrl
Especifica a URL da chave e da versão no Azure Key Vault 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.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | wi |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.