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 administrativeUnits recentemente criados, atualizados ou eliminados sem ter de efetuar uma leitura completa de toda a coleção de recursos. Para obter mais informações, consulte Utilizar a consulta delta para controlar as alterações nos dados do Microsoft Graph para obter detalhes.
Esta API está disponível nas seguintes implementações de cloud nacionais.
Serviço global | US Government L4 | US Government L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
Tipo de permissão | Permissões com menos privilégios | Permissões com privilégios superiores |
---|---|---|
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. |
Application | AdministrativeUnit.Read.All | AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Importante
Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ser um utilizador membro ou ser-lhe atribuída uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.
- Leitores de Diretórios – Ler propriedades básicas e membros de unidades administrativas
- Leitor Global – Ler todas as propriedades das unidades administrativas, incluindo membros
- Administrador de Funções Com Privilégios – faça a gestão total de unidades administrativas, incluindo membros, mas excluindo unidades administrativas restritas. Para obter mais informações, veja Unidades administrativas de gestão restrita no Microsoft Entra ID
Solicitação HTTP
Para começar a controlar as alterações, faça um pedido que inclua a função delta no recurso administrativeUnit .
GET /administrativeUnits/delta
Parâmetros de consulta
As alterações de controlo incorrem numa ronda 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.
Só tem de especificar quaisquer parâmetros de consulta uma vez adiantados.
Nos pedidos subsequentes, copie e aplique o @odata.nextLink
URL ou @odata.deltaLink
da resposta anterior. Esse URL já inclui os parâmetros codificados.
Parâmetro de consulta | Tipo | Descrição |
---|---|---|
$deltatoken | string | Um token de estado devolvido no @odata.deltaLink URL da chamada da função delta anterior para a mesma coleção de recursos, indicando a conclusão dessa ronda de controlo 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 devolvido no @odata.nextLink URL da chamada da função delta anterior, que indica que há mais alterações a serem registadas 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 suportada é para controlar as alterações de recursos específicos, pelo respetivo
$filter
ID:$filter=id+eq+{value}
ou$filter=id+eq+{value1}+or+id+eq+{value2}
. O número de IDs que pode especificar é limitado pelo comprimento máximo do URL.
- A única expressão suportada é para controlar as alterações de recursos específicos, pelo respetivo
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, este método devolve 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 a fazer pedidos com o@odata.nextLink
URL até que um@odata.deltaLink
URL seja incluído na resposta.Se uma URL
@odata.deltaLink
é retornada, não há mais nenhum dado sobre o estado do recurso a ser retornado. Mantenha e utilize o@odata.deltaLink
URL para saber mais sobre as alterações ao recurso no futuro.
Para obter detalhes e um exemplo, veja Utilizar a consulta delta e Obter alterações incrementais para os utilizadores.
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"
}
]
}
]
}