Перечисление зон

Пространство имен: microsoft.graph.security

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получите список объектов зоны и их свойств.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальное обслуживание Правительство США L4 Правительство США L5 (DOD) Китай, обслуживаемый 21Vianet
✅ ❌ ❌ ❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более высокий уровень привилегий или разрешений, только если это требуется вашему приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в статье Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшим объемом привилегий Разрешения с более высоким уровнем привилегий
Делегированные (рабочая или учебная учетная запись) Zone.Read.All Zone.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение Zone.Read.All Zone.ReadWrite.All

Важно!

Для делегированного доступа с помощью рабочих или учебных учетных записей вошедшему пользователю должна быть назначена поддерживаемая роль Microsoft Entra или пользовательская роль, предоставляющая разрешения, необходимые для этой операции. Эта операция поддерживает следующие встроенные роли, которые предоставляют лишь наименьшее количество необходимых прав:

  • Администратор безопасности
  • Глобальный читатель
  • Читатель сведений о безопасности

HTTP-запрос

GET /security/zones

Необязательные параметры запросов

Этот метод поддерживает параметры запросов $select, $filter, , $count$orderby, $top, $skipи $expand OData, чтобы помочь настроить ответ. Общие сведения см. в статье Параметры запроса OData. Стандартный и максимальный размеры страниц равны 1000 объектов зон.

В следующей таблице перечислены варианты запросов $filter and $orderby для каждого свойства.

Property Операторы $filter $orderby
created/dateTime ge, le, gt, lt ✓
description eq, contains
displayName eq, contains ✓
id eq
modified/dateTime ge, le, gt, lt ✓
Агрегаты/виды eq (в any() выражении)
Количество агрегаций и их количества gt, lt, ge, ( le в any() выражении)

В следующей таблице приведены примеры шаблонов запросов.

Шаблон запроса Пример
Фильтр по отображаемому имени $filter=displayName eq 'Production Zone'
Фильтр по описанию содержит $filter=contains(description, 'production')
Фильтровать по дате создания $filter=created/dateTime ge 2023-01-01T00:00:00Z
Фильтр по типу среды $filter=aggregations/any(a: a/kind eq 'azureSubscription')
Фильтровать по количеству сред $filter=aggregations/any(a: a/kind eq 'azureSubscription' and a/count gt 5)
Упорядочивание по отображаемому имени $orderby=displayName asc
Сортировка по дате создания по убыванию $orderby=created/dateTime desc
Разбивка на страницы $top=10&$skip=20&$count=true
Выделение определенных полей $select=id,displayName,aggregations
Расширение сред $expand=environments

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения об аутентификации и авторизации.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успеха этот метод возвращает 200 OK код отклика и коллекцию объектов microsoft.graph.security.zone в тексте ответа.

Примеры

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/beta/security/zones

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/security/$metadata#zones",
  "value": [
    {
      "@odata.type": "#microsoft.graph.security.zone",
      "id": "05cfec937c214892a14448562ef4bf4a",
      "displayName": "Production Zone",
      "description": "Zone for production environments",
      "created": {
        "by": "Yarin",
        "dateTime": "2023-10-01T12:00:00Z"
      },
      "modified": {
        "by": "Yarin",
        "dateTime": "2023-10-01T12:00:00Z"
      },
      "aggregations": [
        {
          "kind": "azureSubscription",
          "count": 1
        },
        {
          "kind": "awsAccount",
          "count": 2
        },
        {
          "kind": "gcpProject",
          "count": 1
        }
      ]
    },
    {
      "@odata.type": "#microsoft.graph.security.zone",
      "id": "95b3220fe91548eaae9e812b30bbd735",
      "displayName": "Development Zone",
      "description": "Zone for development environments",
      "created": {
        "by": "Yarin",
        "dateTime": "2023-10-01T12:00:00Z"
      },
      "modified": {
        "by": "Yarin",
        "dateTime": "2023-10-01T12:00:00Z"
      },
      "aggregations": [
        {
          "kind": "awsAccount",
          "count": 1
        }
      ]
    }
  ]
}
  • Last updated on