Compartilhar via

Obter Unidade

  • Artigo

Recupere as propriedades e as relações de um recurso Drive.

Uma unidade é um contêiner de nível superior para um sistema de arquivos como as bibliotecas de documentos do OneDrive ou do SharePoint.

Permissões

Uma das permissões a seguir é necessária para chamar essa API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All
Aplicativo Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Obter o OneDrive do usuário atual

A unidade do usuário conectado (ao usar a autenticação delegada) poderá ser acessada pelo me singleton.

Se o OneDrive do usuário não está provisionado, mas o usuário tem uma licença para usar o OneDrive, esta solicitação provisionará automaticamente ao usar a autenticação delegada.

Solicitação HTTP

GET /me/drive

Ao usar o ponto de extremidade de serviço direto do OneDrive, não inclua o segmento /me.

GET /drive

Obtenha o OneDrive de um usuário

Para acessar o OneDrive ou o OneDrive for Business de um usuário, seu aplicativo deve solicitar a relação drive no recurso User.

Se o OneDrive do usuário não está provisionado, mas o usuário tem uma licença para usar o OneDrive, esta solicitação provisionará automaticamente ao usar a autenticação delegada.

Solicitação HTTP

GET /users/{idOrUserPrincipalName}/drive

Parâmetros do caminho

Nome do parâmetro Valor Descrição
idOrUserPrincipalName string Obrigatório. O identificador de objeto do usuário proprietário do OneDrive.

Obtenha a biblioteca de documentos associada a um grupo

Para acessar uma biblioteca de documentos padrão de um Grupo, o aplicativo solicita a relação drive no grupo.

Solicitação HTTP

GET /groups/{groupId}/drive

Parâmetros do caminho

Nome do parâmetro Valor Descrição
groupId string Obrigatório. O identificador do grupo proprietário da biblioteca de documentos.

Obter a biblioteca de documentos de um site

Para acessar uma biblioteca de documentos padrão de um Site, o aplicativo solicita a relação drive no Site.

Solicitação HTTP

GET /sites/{siteId}/drive

Parâmetros do caminho

Nome do parâmetro Valor Descrição
siteId string Obrigatório. O identificador do site que contém a biblioteca de documentos.

Obtenha uma unidade por ID

Se tiver o identificador exclusivo de uma unidade, você poderá acessá-lo diretamente da coleção de unidades de nível superior.

Solicitação HTTP

GET /drives/{drive-id}

Parâmetros do caminho

Nome do parâmetro Valor Descrição
driveId cadeia de caracteres Obrigatório. O identificador da unidade solicitada.

Parâmetros de consulta opcionais

Esse método é compatível com o parâmetro de consulta $select para formar a resposta.

Resposta HTTP:

Cada um desses métodos retorna um Recurso de Unidade para a unidade correspondente no corpo da resposta.

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

{
    "id": "b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7",
    "driveType": "business",
    "owner": {
        "user": {
            "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
            "displayName": "Ryan Gregg"
        }
    },
    "quota": {
        "deleted": 256938,
        "fileCount": 2,
        "remaining": 1099447353539,
        "state": "normal",
        "total": 1099511627776
    }
}

Códigos de resposta de erro

Se a unidade não existir e não puder ser provisionada automaticamente (ao usar autenticação delegada) uma resposta HTTP 404 será retornada.