Enumerar sitios

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Enumere todos los sitios disponibles en una organización.

También se admiten criterios de filtro y opciones de consulta específicos y se describen a continuación:

Instrucción Filter Select (instrucción) Descripción
siteCollection/root ne null siteCollection,webUrl Listas todas las colecciones de sitios de nivel raíz de la organización. Útil para descubrir el sitio principal de cada geografía.

Además, puede usar una consulta de $search en la /sites colección para buscar sitios que coincidan con palabras clave dadas. Si desea enumerar todos los sitios de todas las zonas geográficas, consulte getAllSites.

Para obtener más instrucciones sobre cómo compilar aplicaciones que usan la detección de sitios con fines de examen, consulte Procedimientos recomendados para detectar archivos y detectar cambios a escala.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ✅

Permisos

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.

Enumerar todas las colecciones de sitios

Tipo de permiso Permisos (de menos a más privilegiados)
Delegado (cuenta profesional o educativa) No admitida.
Delegado (cuenta personal de Microsoft) No admitida.
Aplicación Sites.Read.All, Sites.ReadWrite.All

Descubrir el sitio principal para cada geografía

Tipo de permiso Permisos (de menos a más privilegiados)
Delegado (cuenta profesional o educativa) Sites.Read.All, Sites.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida.
Aplicación Sites.Read.All, Sites.ReadWrite.All

Solicitud HTTP

Para enumerar todos los sitios disponibles en una organización:

GET /sites

Para enumerar todas las colecciones de sitios de nivel raíz de una organización:

GET /sites?$filter=siteCollection/root ne null

Ejemplo

Solicitud

GET https://graph.microsoft.com/beta/sites?$select=siteCollection,webUrl&$filter=siteCollection/root%20ne%20null

Respuesta

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee8740",
      "name": "Contoso USA",
      "root": { },
      "siteCollection": {
        "hostname": "contoso.sharepoint.com",
        "dataLocationCode": "NAM",
        "root": { }
      },
      "webUrl": "https://contoso.sharepoint.com"
    },
    {
      "id": "contoso-jpn.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,0271110f-634f-4300-a841-3a8a2e851851",
      "name": "Contoso Japan",
      "root": { },
      "siteCollection": {
        "hostname": "contoso-jp.sharepoint.com",
        "dataLocationCode": "JPN",
        "root": { }
      },
      "webUrl": "https://contoso-jp.sharepoint.com"
    }
  ]
}

Solicitud

GET /sites

Respuesta

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "contoso.sharepoint.com,bf6fb551-d508-4946-a439-b2a6154fc1d9,65a04b8b-1f44-442b-a1fc-9e5852fb946c",
      "name": "Root Site",
      "root": { },
      "siteCollection": {
        "hostname": "contoso.sharepoint.com",
        "dataLocationCode": "NAM",
        "root": { }
      },
      "webUrl": "https://contoso.sharepoint.com"
    },
    {
      "id": "contoso.sharepoint.com,d9ecf079-9b13-4376-ac5d-f242dda55626,746dbcc1-fa2b-4120-b657-2670bae5bb6f",
      "name": "Site A",
      "root": { },
      "siteCollection": {
        "hostname": "contoso.sharepoint.com"
      },
      "webUrl": "https://contoso.sharepoint.com/sites/siteA"
    },
    {
      "id": "contoso.sharepoint.com,fd1a778f-263e-4c43-acdf-d5c2519d80eb,c06016db-dfec-4f79-83a1-09c6dbfd7022",
      "name": "Site B",
      "root": { },
      "siteCollection": {
        "hostname": "contoso.sharepoint.com"
      },
      "webUrl": "https://contoso.sharepoint.com/sites/siteB"
    }
  ]
}