Obter bitlockerRecoveryKey

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Recupere as propriedades e as relações de um objeto bitlockerRecoveryKey .

Por padrão, essa operação não retorna a propriedade key que representa a chave de recuperação real. Para incluir a propriedade key na resposta, use o parâmetro $select de consulta OData. Incluir o $select parâmetro de consulta dispara uma auditoria do Azure AD da operação e gera um log de auditoria. Você pode encontrar o log nos logs de auditoria do Azure AD na categoria KeyManagement.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (de privilégios máximos a mínimos)
Delegado (conta corporativa ou de estudante) BitLockerKey.ReadBasic.All, BitLockerKey.Read.All
Delegado (conta pessoal da Microsoft) Sem suporte
Aplicativo Sem suporte

Observação: Para permissões delegadas permitirem que os aplicativos recebam recursos bitLockerRecoveryKey em nome do usuário conectado, o administrador de locatários deve ter atribuído ao usuário uma das seguintes funções ou o usuário deve ser o proprietário registrado do dispositivo do qual a chave BitLocker foi originalmente backup:

  • Administrador global
  • Administrador de dispositivos de nuvem
  • Administrador da assistência técnica
  • Administrador de Serviço do Intune
  • Administrador de segurança
  • Leitor de segurança
  • Leitor global

Solicitação HTTP

Para obter a chave BitLocker especificada sem retornar a propriedade key :

GET /informationProtection/bitlocker/recoveryKeys/{bitlockeryRecoveryKeyId}

Para obter a chave BitLocker especificada, incluindo sua propriedade chave :

GET /informationProtection/bitlocker/recoveryKeys/{bitlockeryRecoveryKeyId}?$select=key

Parâmetros de consulta opcionais

Este método dá suporte ao $select parâmetro de consulta OData para retornar a propriedade key . Para obter detalhes, consulte o Exemplo 2. Para obter informações gerais, acesse Parâmetros de consulta OData.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório.
User-Agent O identificador do aplicativo de chamada. Esse valor contém informações sobre o sistema operacional e o navegador usado. Obrigatório.
ocp-client-name O nome do aplicativo cliente que executa a chamada da API. Esse header é usado para fins de depuração. Opcional.
ocp-client-version A versão do aplicativo cliente que executa a chamada da API. Esse header é usado para fins de depuração. Opcional.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se tiver êxito, este método retornará um 200 OK código de resposta e um objeto bitlockerRecoveryKey no corpo da resposta.

Exemplos

Exemplo 1

Obter a chave BitLocker especificando a id da chave. Este exemplo não retorna a propriedade key .

Solicitação

Este é um exemplo de solicitação.

GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4
User-Agent: "Dsreg/10.0 (Windows 10.0.19043.1466)"
ocp-client-name: "My Friendly Client"
ocp-client-version: "1.2"

Resposta

Este é um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": {
    "@odata.type": "#microsoft.graph.bitlockerRecoveryKey",
    "id": "b465e4e8-e4e8-b465-e8e4-65b4e8e465b4",
    "createdDateTime": "2020-06-15T13:45:30.0000000Z",
    "volumeType": 1,
    "deviceId": "1ab40ab2-32a8-4b00-b6b5-ba724e407de9"
  }
}

Exemplo 2

Obter a chave BitLocker com a propriedade key especificando a id da chave.

Solicitação

Este é um exemplo de solicitação.

GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4?$select=key
User-Agent: "Dsreg/10.0 (Windows 10.0.19043.1466)"
ocp-client-name: "My Friendly Client"
ocp-client-version: "1.2"

Resposta

Este é um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": {
    "@odata.type": "#microsoft.graph.bitlockerRecoveryKey",
    "id": "b465e4e8-e4e8-b465-e8e4-65b4e8e465b4",
    "createdDateTime": "String (timestamp)",
    "volumeType": 1,
    "deviceId": "1ab40ab2-32a8-4b00-b6b5-ba724e407de9",
    "key": "123456-231453-873456-213546-654678-765689-123456-324565"
  }
}