administrativeUnit: delta
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 Versão.
Obtenha as unidades administrativas recém-criadas, atualizadas ou excluídas sem precisar executar uma leitura completa de toda a coleção de recursos. Para obter detalhes, consulte Usando consulta delta.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | AdministrativeUnit.Read.All | AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | AdministrativeUnit.Read.All | AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Solicitação HTTP
Para começar a acompanhar as alterações, você faz uma solicitação que inclui a função delta no recurso administrativeUnit .
GET /administrativeUnits/delta
Parâmetros de consulta
O acompanhamento de alterações incorre em uma rodada de uma ou mais chamadas de função delta . Se você usar qualquer parâmetro de consulta (diferente de $deltatoken
e $skiptoken
), especifique-o na primeira solicitação delta. O Microsoft Graph codifica automaticamente todos os parâmetros especificados na parte do token da URL @odata.nextLink
ou @odata.deltaLink
fornecida na resposta.
Você só precisa especificar todos os parâmetros de consulta uma vez antecipadamente.
Em solicitações subsequentes, copie e aplique a @odata.nextLink
URL ou @odata.deltaLink
da resposta anterior. Essa URL já inclui os parâmetros codificados.
Parâmetro de consulta | Tipo | Descrição |
---|---|---|
$deltatoken | string | Um token de estado retornado na @odata.deltaLink URL da chamada de função delta anterior para a mesma coleção de recursos, indicando a conclusão dessa rodada de rastreamento de alterações. Salve e aplique toda a URL @odata.deltaLink , incluindo esse token na primeira solicitação da próxima série de controle de alterações desse conjunto. |
$skiptoken | string | Um token de estado retornado na @odata.nextLink URL da chamada de função delta anterior, indicando que há outras alterações a serem rastreadas na mesma coleção de recursos. |
Parâmetros de consulta opcionais
Este método suporta os seguintes parâmetros de consulta OData para ajudar a personalizar a resposta:
Você pode usar um parâmetro de consulta
$select
como em qualquer solicitação GET para especificar somente as propriedades necessárias para obter melhor desempenho. A propriedade id sempre será retornada.Há suporte limitado para
$filter
:- A única expressão com
$filter
suporte é para acompanhar alterações para recursos específicos, por sua ID:$filter=id+eq+{value}
ou$filter=id+eq+{value1}+or+id+eq+{value2}
. O número de IDs que você pode especificar é limitado pelo comprimento máximo da URL.
- A única expressão com
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, esse método retornará 200 OK
o código de resposta e um objeto de coleção administrativeUnit no corpo da resposta. A resposta também inclui uma URL @odata.nextLink
ou uma URL @odata.deltaLink
.
Se uma URL
@odata.nextLink
é retornada, existem páginas de dado adicionais a serem recuperadas na sessão. O administrativeUnit continua fazendo solicitações usando a@odata.nextLink
URL até que uma@odata.deltaLink
URL seja incluída na resposta.Se uma URL
@odata.deltaLink
é retornada, não há mais nenhum dado sobre o estado do recurso a ser retornado. Persista e use a@odata.deltaLink
URL para saber mais sobre as alterações no recurso no futuro.
Para obter detalhes e um exemplo, consulte Usando consulta delta e Obter alterações incrementais para usuários.
Exemplo
Solicitação
GET https://graph.microsoft.com/beta/administrativeUnits/delta
Resposta
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#administrativeunits",
"@odata.nextLink":"https://graph.microsoft.com/beta/administrativeunits/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"displayName": "Management Fast Track",
"visibility": null,
"extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType": "School",
"extension_fe2174665583431c953114ff7268b7b3_Education_StateId": "WA",
"extension_fe2174665583431c953114ff7268b7b3_Education_Address": "2 Microsoft Way",
"extension_fe2174665583431c953114ff7268b7b3_Education_City": "Redmond",
"extension_fe2174665583431c953114ff7268b7b3_Education_State": "WA",
"extension_fe2174665583431c953114ff7268b7b3_Education_Country": "US",
"extension_fe2174665583431c953114ff7268b7b3_Education_Zip": "98052",
"extension_fe2174665583431c953114ff7268b7b3_Education_Phone": "555-123-4567",
"extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource": "SIS",
"extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId": "10002",
"extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalSyncSourceId": "14008",
"extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalName": "Amy Roebuck",
"extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalEmail": "aroebuck@principal.edu",
"extension_fe2174665583431c953114ff7268b7b3_Education_SchoolZone": "1",
"id": "8a07f5a8-edc9-4847-bbf2-dde106594bf4",
"members@delta": [
{
"@odata.type": "#microsoft.graph.user",
"id": "b66ecf79-a093-4d51-86e0-efcc4531f37a"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "5bde3e51-d13b-4db1-9948-fe4b109d11a7"
},
{
"@odata.type": "#microsoft.graph.group",
"id": "801f2093-de7e-4883-a786-8a5f30874ff4"
},
{
"@odata.type": "#microsoft.graph.group",
"id": "7e4ec76c-8276-43ef-ba10-9aaa197cb212"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "f5289423-7233-4d60-831a-fe107a8551cc"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "48d31887-5fad-4d73-a9f5-3c356e68a038"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "c03e6eaa-b6ab-46d7-905b-73ec7ea1f755"
}
]
}
]
}