servicePrincipal: 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 principais de serviço 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) | Directory.Read.All | Application.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | Application.ReadWrite.OwnedBy | Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Solicitação HTTP
Para começar a controlar as alterações, faça um pedido ao incluir a função delta no recurso servicePrincipal.
GET /servicePrincipals/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 opcionais
Este método dá suporte a 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
$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. |
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 código de resposta e um 200 OK
objeto de coleção servicePrincipal no corpo da resposta. A resposta também inclui um URL nextLink ou um URL de deltaLink.
Se uma URL
@odata.nextLink
é retornada, existem páginas de dado adicionais a serem recuperadas na sessão. A aplicação continua a fazer pedidos para utilizar o@odata.nextLink
URL até que um@odata.deltaLink
URL seja incluído na resposta.Se for devolvido um
@odata.deltaLink
URL, não existem mais dados sobre o estado existente do recurso a ser devolvido. Mantenha e utilize o@odata.deltaLink
URL para saber mais sobre as alterações ao recurso no futuro.
Veja:
-
Utilizar a Consulta Delta para obter mais detalhes
-
Obtenha alterações incrementais para os utilizadores para um pedido de exemplo.
Exemplo
Solicitação
GET https://graph.microsoft.com/beta/servicePrincipals/delta
Resposta
Observação: o objeto de resposta exibido aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#servicePrincipals",
"@odata.nextLink":"https://graph.microsoft.com/beta/servicePrincipals/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"accountEnabled": true,
"addIns": [
{
"id": "id-value",
"type": "type-value",
"properties": [
{
"key": "key-value",
"value": "value-value"
}
]
}
],
"appDisplayName": "appDisplayName-value",
"appId": "appId-value",
"appOwnerOrganizationId": "appOwnerOrganizationId-value",
"appRoleAssignmentRequired": true
}
]
}