Table of contents

Consultas comunes de Graph APIGraph API Common Queries

Jimaco Brannian|Última actualización: 19/06/2018
|
2 Colaboradores

En este tema se muestran algunas consultas comunes que se pueden realizar con la API de Azure AD Graph.This topic shows some common queries that can be performed with the Azure AD Graph API.Para obtener más información sobre las operaciones admitidas al consultar Graph, consulte Consultas, filtros y opciones de paginación admitidos con la API de 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

Se recomienda encarecidamente que use Microsoft Graph en lugar de la API de Azure AD Graph para acceder a recursos de Azure Active Directory.We strongly recommend that you use Microsoft Graph instead of Azure AD Graph API to access Azure Active Directory resources.Nuestros esfuerzos de desarrollo se concentran ahora en Microsoft Graph y no están previstas mejoras adicionales para la API de Azure AD Graph.Our development efforts are now concentrated on Microsoft Graph and no further enhancements are planned for Azure AD Graph API.Hay un número muy limitado de escenarios para los que la API de Azure AD Graph todavía podría ser adecuada; para más información, vea la entrada del blog Microsoft Graph o Azure AD Graph en el centro de desarrollo de 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.

DireccionamientoAddressing

Todas las consultas siguientes se dirigen al inquilino mediante un nombre de dominio.The queries below all address the tenant using a domain name.Puede reemplazar contoso.com por uno de los nombres de dominio registrados de su inquilino, por el identificador de su inquilino (GUID) o por el alias MyOrganization (para acceso 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 obtener información sobre otras maneras de dirigirse al inquilino, consulte Dirigirse a entidades y operaciones en Graph API.For information about other ways of addressing the tenant, see Addressing Entities and Operations in the Graph API.

Consulta de recursos de nivel superiorQuerying Top-Level Resources

Las siguientes consultas comunes muestran cómo acceder a recursos de nivel superior con Graph API mediante contoso.com como inquilino de ejemplo.The following common queries demonstrate how to access top-level resources with the Graph API using contoso.com as the example tenant.Tenga en cuenta que será necesario un encabezado Authorization que contenga un token de portador válido recibido de Azure AD para ejecutar consultas en un inquilino.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 nivel superiorTop-Level ResourceResultados de la consultaQuery ResultsURI (para contoso.com)URI (for contoso.com)
Recursos de nivel superiorTop-level resourcesDevuelve la lista de URI de los recursos de nivel superior para los servicios de directorio (también se muestran a continuación)Returns URI list of the top-level resources for directory services (also listed below)https://graph.windows.net/contoso.com?api-version=1.6
Información de la compañíaCompany informationDevuelve información de la compañíaReturns company informationhttps://graph.windows.net/contoso.com/tenantDetails?api-version=1.6
ContactosContactsDevuelve información de contacto organizativaReturns organizational contact informationhttps://graph.windows.net/contoso.com/contacts?api-version=1.6
UsuariosUsersDevuelve información de usuariosReturns user informationhttps://graph.windows.net/contoso.com/users?api-version=1.6
GruposGroupsDevuelve datos de gruposReturns group datahttps://graph.windows.net/contoso.com/groups?api-version=1.6
Roles de directorioDirectory RolesDevuelve todos los roles de directorio activados en el inquilinoReturns all activated directory roles in the tenanthttps://graph.windows.net/contoso.com/roles?api-version=1.6
SubscribedSkusSubscribedSkusDevuelve las suscripciones del inquilinoReturns the tenant's subscriptionshttps://graph.windows.net/contoso.com/subscribedSkus?api-version=1.6
Metadatos de directorioDirectory metadataDevuelve un documento de metadatos del servicio que describe el modelo de datos (es decir, la estructura y la organización de los recursos del directorio)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

Operaciones de consultaQuery Operations

En la siguiente tabla se muestran algunos ejemplos de consultas de Graph API que usan contoso.com como inquilino de ejemplo.The following table shows some example Graph API queries using using contoso.com as the example tenant.

Operación de consultaQuery OperationURI (para contoso.com)URI (for contoso.com)
Mostrar todos los usuarios y 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 un usuario individual especificando objectId 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
Solicitud y filtrado de un usuario cuyo displayName es 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 y filtrar usuarios específicos cuyo firstName es igual que "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
Filtrar por valores givenName y surnameFilter 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 un grupo individual especificando objectIdRetrieve individual group by specifying the objectIdhttps://graph.windows.net/contoso.com/groups/06790a81-0382-434c-b40e-216fa41bda21?api-version=1.6
Recuperar el administrador de un usuarioRetrieve a user’s managerhttps://graph.windows.net/contoso.com/users/John.Smith@contoso.com/manager?api-version=1.6
Recuperar la lista de subordinados directos de un usuarioRetrieve a user’s direct reports listhttps://graph.windows.net/contoso.com/users/3c4a09b0-a7b6-444e-9702-96983635a66e/directReports?api-version=1.6
Recuperar una lista de vínculos a los subordinados directos de un usuarioRetrieve 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 la lista de pertenencias de un grupoRetrieve membership list of a grouphttps://graph.windows.net/contoso.com/groups/3f575eef-bb04-44a5-a9af-eee9f547e3f9/members?api-version=1.6
Recuperar una lista de vínculos a los miembros de un grupoRetrieve 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 la pertenencia a grupos de un usuario (no 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 una lista de los grupos de los que el usuario es miembro (no transitiva)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
Solicitud y filtrado para grupos con displayName >= "az" y <= "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

Nota: El espacio en blanco de la cadena de consulta debe codificarse para URL antes de enviar una solicitud.Note: White space in the query string should be URL-encoded before sending a request.Por ejemplo, la siguiente cadena de consulta, https://graph.windows.net/contoso.com/Users?$filter=displayName eq 'Jon Doe'&api-version=1.6, debe codificarse para 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