directoryRole: delta
Namespace: microsoft.graph
Obtenha funções de diretório recentemente criadas, atualizadas ou eliminadas 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) | 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 |
Importante
Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter 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.
- Administrador do usuário
- Administrador da Assistência Técnica
- Administrador do Suporte de Serviços
- Administrador de Cobrança
- Usuário
- Administrador de caixa de correio
- Leitores de Diretórios
- Escritores de diretório
- Administrador de Aplicativos
- Leitor de segurança
- Administrador de Segurança
- Administrador de Função Privilegiada
- Administrador de Aplicativos de Nuvem
- Aprovador de Acesso do Sistema de Proteção de Dados do Cliente
- Administrador do Dynamics 365
- Administrador do Power BI
- Administrador Proteção de Informações do Azure
- Administrador do Análise de Área de Trabalho
- Administrador de Licenças
- Administrador de Ambiente de Trabalho Gerido da Microsoft
- Administrador de Autenticação
- Administrador de Autenticação Privilegiada
- Administrador de Comunicações do Teams
- Engenheiro de Suporte de Comunicações de Equipes
- Especialista em suporte à comunicação de equipes
- Administrador do Teams
- Insights do Administrador
- Administrador de Dados de Conformidade
- Operador de Segurança
- Administrador do Kaizala
- Leitor Global
- Utilizador do Centro de Empresas de Licenciamento em Volume
- Utilizador do Centro de Serviços de Licenciamento em Volume
- Administrador de Comércio Moderno
- Utilizador Microsoft Store para Empresas
- Revisor de Diretórios
Solicitação HTTP
Para começar a controlar as alterações, faça um pedido que inclui a função delta no recurso directoryRole .
GET /directoryRoles/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.
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 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 OData
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 suportada
$filter
é para controlar as alterações de recursos específicos, pelo respetivo 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
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, este método devolve um 200 OK
código de resposta e um objeto de coleção directoryRole 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 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. Guarde@odata.deltaLink
o URL e aplique-o na próxima chamada delta para saber mais sobre as alterações ao recurso no futuro.
Exemplo
Solicitação
GET https://graph.microsoft.com/v1.0/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/v1.0/$metadata#directoryRoles",
"@odata.nextLink": "https://graph.microsoft.com/v1.0/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"
}
}
]
}
]
}
Conteúdo relacionado
- Utilize a consulta delta para controlar as alterações nos dados do Microsoft Graph para obter mais detalhes
- Obter as alterações incrementais para usuários para solicitações de um exemplo.