directoryRole: 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 funções de diretório recém-criadas, atualizadas ou excluídas sem precisar executar uma leitura completa de toda a coleção de recursos. Consulte Usando a Consulta Delta para obter detalhes.
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) | RoleManagement.Read.Directory | Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | RoleManagement.Read.Directory | Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory |
Solicitação HTTP
Para começar a acompanhar as alterações, você faz uma solicitação, incluindo a função delta no recurso directoryRole.
GET /directoryRoles/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 uma vez os parâmetros de consulta desejados antecipadamente.
Em solicitações subsequentes, copie e aplique a URL @odata.nextLink
ou @odata.deltaLink
da resposta anterior, já que essa URL inclui os parâmetros codificados desejados.
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 dá suporte a Parâmetros de consulta do 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. |
Content-Type | application/json |
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á um código de resposta e um 200 OK
objeto de coleção directoryRole no corpo da resposta. A resposta também inclui uma URL nextLink ou uma URL deltaLink.
Se uma URL
@odata.nextLink
é retornada, existem páginas de dado adicionais a serem recuperadas na sessão. O aplicativo continua fazendo solicitações usando a URL@odata.nextLink
até uma URL@odata.deltaLink
ser 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.
Confira:
- Usando a Consulta Delta para obter mais detalhes
- Obtenha alterações incrementais para usuários para uma solicitação de exemplo.
Exemplo
Solicitação
GET https://graph.microsoft.com/beta/directoryRoles/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#directoryRoles",
"@odata.nextLink": "https://graph.microsoft.com/beta/directoryRoles/delta?$skiptoken=pkXMyA5aFCIMmH1Kk1XEAnf2X-fodqXKXF03gYPQknSHRxogVsxvSq_26nhos-O2-shortened",
"value": [
{
"description": "Device Administrators",
"displayName": "Azure AD Joined Device Local Administrator",
"roleTemplateId": "9f06204d-73c1-4d4c-880a-6edb90606fd8",
"id": "f8e85ed8-f66f-4058-b170-3efae8b9c6e5",
"members@delta": [
{
"@odata.type": "#microsoft.graph.user",
"id": "bb165b45-151c-4cf6-9911-cd7188912848",
"@removed": {
"reason": "deleted"
}
}
]
}
]
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: ao longo de 2024, vamos eliminar problemas do GitHub como o mecanismo de comentários para conteúdo e substituí-lo por um novo sistema de comentários. Para obter mais informações, consulte:Enviar e exibir comentários de