Table of contents

Consultas Comuns da API do GraphGraph API Common Queries

Jimaco Brannian|Última Atualização: 19/06/2018
|
2 Colaboradores

Este tópico lista as consultas comuns que podem ser executadas com a API do Azure AD Graph.This topic shows some common queries that can be performed with the Azure AD Graph API.Para obter mais informações sobre as operações com suporte ao consultar o Graph, veja Supported Queries, Filters, and Paging Options in Azure AD Graph API (Consultas, Filtros e Opções de Paginação com Suporte na API do Azure AD Graph).For more information about supported operations when querying the Graph, see Supported Queries, Filters, and Paging Options in Azure AD Graph API.

Importante

Recomendamos que você use o Microsoft Graph em vez da API do Azure AD Graph para acessar os recursos do Azure Active Directory.We strongly recommend that you use Microsoft Graph instead of Azure AD Graph API to access Azure Active Directory resources.Nossos esforços de implantação agora estão concentrados no Microsoft Graph e não há planos de novos aprimoramento para a API do Azure AD Graph.Our development efforts are now concentrated on Microsoft Graph and no further enhancements are planned for Azure AD Graph API.Há um número muito limitado de cenários para os quais a API do Azure AD Graph ainda pode ser adequada. Para saber mais, confira a postagem do blog sobre Microsoft Graph ou Azure AD Graph no Centro de Desenvolvimento do Office.There are a very limited number of scenarios for which Azure AD Graph API might still be appropriate; for more information, see the Microsoft Graph or the Azure AD Graph blog post in the Office Dev Center.

EndereçamentoAddressing

Todas as consultas abaixo abordam o locatário usando um nome de domínio.The queries below all address the tenant using a domain name.Você pode substituir contoso.com por um dos nomes de domínio registrados do locatário, com a ID do locatário (GUID) ou com o alias MyOrganization (para acesso delegado).You can replace contoso.com with one of your tenant’s registered domain names, with your tenant's ID (GUID), or with the MyOrganization alias (for delegated access).Para obter informações sobre outras maneiras de tratar o locatário, consulte Addressing Entities and Operations in the Graph API (Endereçamento de Entidades e Operações na API do Graph).For information about other ways of addressing the tenant, see Addressing Entities and Operations in the Graph API.

Consultando recursos de alto nívelQuerying Top-Level Resources

As consultas comuns a seguir demonstram como acessar os recursos de alto nível no com a API do Graph usando contoso.com como o locatário de exemplo.The following common queries demonstrate how to access top-level resources with the Graph API using contoso.com as the example tenant.Observe que um cabeçalho de Autorização que contém um token de portador válido recebido do Azure AD será necessário para executar consultas em um locatário.Note that an Authorization header containing a valid bearer token received from Azure AD will be required to run queries against a tenant.

Recurso de nível superiorTop-Level ResourceResultados da consultaQuery ResultsURI (para contoso.com)URI (for contoso.com)
Recursos de alto nívelTop-level resourcesRetorna uma lista de URI dos recursos de alto nível para serviços de diretório (também listados abaixo)Returns URI list of the top-level resources for directory services (also listed below)https://graph.windows.net/contoso.com?api-version=1.6
Informações da empresaCompany informationRetorna informações da empresaReturns company informationhttps://graph.windows.net/contoso.com/tenantDetails?api-version=1.6
ContactsContactsRetorna informações de contato organizacionalReturns organizational contact informationhttps://graph.windows.net/contoso.com/contacts?api-version=1.6
UsuáriosUsersRetorna informações do usuárioReturns user informationhttps://graph.windows.net/contoso.com/users?api-version=1.6
GruposGroupsRetorna dados do grupoReturns group datahttps://graph.windows.net/contoso.com/groups?api-version=1.6
Funções de DiretórioDirectory RolesRetorna todas as funções de diretório ativadas no locatárioReturns all activated directory roles in the tenanthttps://graph.windows.net/contoso.com/roles?api-version=1.6
SubscribedSkusSubscribedSkusRetorna as assinaturas do locatárioReturns the tenant's subscriptionshttps://graph.windows.net/contoso.com/subscribedSkus?api-version=1.6
Metadados do diretórioDirectory metadataRetorna um Documento de Metadados de Serviço que descreve o modelo de dados (isto é, a estrutura e a organização de recursos do diretório)Returns a Service Metadata Document that describes the data model (that is, structure and organization of directory resources)https://graph.windows.net/contoso.com/$metadata?api-version=1.6

Operadores de consultaQuery Operations

A tabela a seguir mostra alguns exemplos de consultas de API do Graph usando contoso.com como o locatário de exemplo.The following table shows some example Graph API queries using using contoso.com as the example tenant.

Operação de consultaQuery OperationURI (para contoso.com)URI (for contoso.com)
Listar todos os usuários e gruposList all Users and Groupshttps://graph.windows.net/contoso.com/users?api-version=1.6

https://graph.windows.net/contoso.com/groups?api-version=1.6
Recuperar o usuário individual especificando o objectId ou o userPrincipalNameRetrieve individual User by specifying the objectId or userPrincipalNamehttps://graph.windows.net/contoso.com/users/d1f67a6c-02c9-4fe5-81fb-58160ce24fe5?api-version=1.6

https://graph.windows.net/contoso.com/users/admin@contoso.com?api-version=1.6
Solicitar e filtrar um usuário com displayName igual a “Jon Doe”Request and Filter for a user with displayName equal to “Jon Doe”https://graph.windows.net/contoso.com/Users?$filter=displayName eq 'Jon Doe'&api-version=1.6
Solicitar e filtrar usuários específicos com firstName igual a “Jon”Request and Filter for specific users with firstName equal to “Jon”https://graph.windows.net/contoso.com/users?$filter=givenName eq 'Jon'&api-version=1.6
Filtre para valores de givenName e surname.Filter for givenName and surname values.https://graph.windows.net/contoso.com/users?$filter=givenName eq 'Jon' and surname eq 'Doe'&api-version=1.6
Recuperar o grupo individual especificando o objectIdRetrieve individual group by specifying the objectIdhttps://graph.windows.net/contoso.com/groups/06790a81-0382-434c-b40e-216fa41bda21?api-version=1.6
Recuperar o gerenciador de um usuárioRetrieve a user’s managerhttps://graph.windows.net/contoso.com/users/John.Smith@contoso.com/manager?api-version=1.6
Recuperar a lista de relatórios diretos de um usuárioRetrieve a user’s direct reports listhttps://graph.windows.net/contoso.com/users/3c4a09b0-a7b6-444e-9702-96983635a66e/directReports?api-version=1.6
Recuperar uma lista de links para relatórios diretos de um usuárioRetrieve a list of links to a user’s direct reportshttps://graph.windows.net/contoso.com/users/3c4a09b0-a7b6-444e-9702-96983635a66e/$links/directReports?api-version=1.6
Recuperar a lista de associação de um grupoRetrieve membership list of a grouphttps://graph.windows.net/contoso.com/groups/3f575eef-bb04-44a5-a9af-eee9f547e3f9/members?api-version=1.6
Recuperar uma lista de links para os membros de um grupo.Retrieve a list of links to the members of a group.https://graph.windows.net/contoso.com/groups/3f575eef-bb04-44a5-a9af-eee9f547e3f9/$links/members?api-version=1.6
Recuperar a associação de grupo de um usuário (não transitiva)Retrieve a user’s group membership (not transitive)https://graph.windows.net/contoso.com/users/ee6308f6-646a-4845-a4e1-57ac96ccc0c8/memberOf?api-version=1.6
Recuperar uma lista dos grupos do qual o usuário é membro (não transitivo)Retrieve a list of the groups that the user is a member of (not transitive)https://graph.windows.net/contoso.com/users/ee6308f6-646a-4845-a4e1-57ac96ccc0c8/$links/memberOf?api-version=1.6
Solicitar e filtrar os grupos com displayName >= "az" e <= "dz"Request and filter for groups with displayName >= "az" and <= "dz"https://graph.windows.net/contoso.com/groups?$filter=displayName ge 'az' and displayName le 'dz'&api-version=1.6

Observação: o espaço em branco na cadeia de caracteres da consulta deve ser codificado para URL antes de enviar uma solicitação.Note: White space in the query string should be URL-encoded before sending a request.Por exemplo, a cadeia de caracteres de consulta a seguir, https://graph.windows.net/contoso.com/Users?$filter=displayName eq 'Jon Doe'&api-version=1.6, deve ser codificada na URL como: https://graph.windows.net/contoso.com/Users?$filter=displayName%20eq%20'Jon%20Doe'&api-version=1.6.For example, the following query string, https://graph.windows.net/contoso.com/Users?$filter=displayName eq 'Jon Doe'&api-version=1.6, should be URL encoded as: https://graph.windows.net/contoso.com/Users?$filter=displayName%20eq%20'Jon%20Doe'&api-version=1.6.

© 2018 Microsoft