Поделиться через


Power Platform для администраторов

Соединитель управления Power Platform предоставляет доступ к возможностям управления жизненным циклом среды, управлению политиками защиты от потери данных и другим возможностям администратора, предоставляемым в API BAP.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Стандарт Все регионы Power Automate
Power Apps Стандарт Все регионы Power Apps
Power Automate Стандарт Все регионы Power Automate
Контакт
Имя Поддержка Microsoft Power Apps
URL https://powerapps.microsoft.com/en-us/support/
Метаданные соединителя
Publisher Microsoft
Website https://admin.powerplatform.microsoft.com/
Политика конфиденциальности https://privacy.microsoft.com/en-us/privacystatement

Power Platform для администраторов — это интерфейс соединителя для доступа к API платформы бизнес-приложений (BAP), который используется для управления ресурсами, связанными с администратором Power Platform, — тот же API, который работает в Центре администрирования Power Platform. Это включает управление жизненным циклом среды и разрешениями, операциями подготовки dataverse, политиками защиты от потери данных и синхронизацией пользователей.

Предпосылки

Любой пользователь может создать удостоверение Microsoft Entra ID, прошедшее проверку подлинности подключения к этому соединителю, данные будут возвращены в зависимости от области действия пользователя.

  • Администраторы службы Power Platform получат доступ ко всем ресурсам и операциям, доступным в клиенте из этой конечной точки.
  • Администраторы среды будут иметь доступ только к данным и операциям в своих средах, политикам защиты от потери данных, которые они могут управлять или влиять на них.

Известные проблемы и ограничения

  1. Не передайте значение NULL или Blank() в качестве группы соединителей API (массив) при создании или обновлении политики защиты от потери данных, она может нарушить политику и стать непригодной для использования с другими непредвиденными последствиями. Если в группе нет соединителей, передайте пустой набор квадратных квадратных скобок [ ].
  2. Старые операции защиты от потери данных не работают с обновленными заблокированными группами защиты от потери данных и устарели. Используйте версии "V2" всех операций защиты от потери данных.
  3. Группы политик защиты от потери данных не заполняются соединителями автоматически, поэтому их необходимо получить, отформатировать и добавить в качестве входных параметров:
    • Сделайте переменную массива для хранения соединителей.
    • Сохраните идентификатор среды клиента по умолчанию в переменную.
    • Используйте операцию GetConnectors из Power Platform для разработчиков приложений, чтобы получить все соединители для среды (используйте фильтр: "environment eq "{environmentName}", где имя среды находится на предыдущем шаге).
    • Используйте операцию Select, чтобы использовать только поля идентификатора, имени и типа из ответа GetConnectors (используйте последний параметр динамического содержимого value). Поместите идентификатор, имя и введите в левую сторону и сопоставийте идентификатор, отображаемое имя и введите в правой части действия выбора.
    • Сохранение выходных данных select в переменной массива
    • Добавьте эти жесткие соединители в переменную массива (они не отображаются в ответе GetConnectors):
      [
          {
            "id": "/providers/Microsoft.PowerApps/apis/shared_microsoftspatialservices",
            "name": "Spatial Services",
            "type": "Microsoft.PowerApps/apis"
          },
          {
            "id": "HttpRequestReceived",
            "name": "When a HTTP request is received",
            "type": "Microsoft.PowerApps/apis"
          },
          {
            "id": "HttpWebhook",
            "name": "HTTP Webhook",
            "type": "Microsoft.PowerApps/apis"
          },
            {
            "id": "Http",
            "name": "HTTP",
            "type": "Microsoft.PowerApps/apis"
          }
      ]
      

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Вывод списка виртуальных соединителей

Возвращает список виртуальных соединителей.

Вывод списка политик защиты от потери данных версии 2

Возвращает список всех политик защиты от потери данных, к которым может получить доступ учетная запись.

Вывод списка разблокируемых соединителей

Возвращает список соединителей, которые не могут быть заблокированы политикой защиты от потери данных.

Вывод списка сред в качестве администратора

Возвращает список сред.

Изменение назначения ролей среды

Задает разрешения для среды.

Обновление политики защиты от потери данных версии 2

Обновляет политику защиты от потери данных.

Обновление политики защиты от потери данных клиента

Обновляет поля в политике защиты от потери данных.

Обновление политики защиты от потери данных среды

Обновляет политику защиты от потери данных среды.

Обновление среды

Обновляет свойства среды.

Перечисление назначений ролей среды

Возвращает список разрешений для среды без CDS для приложений.

Перечисление поддерживаемых валют среды

Возвращает список поддерживаемых валют на основе расположения.

Получение политики защиты от потери данных версии 2

Возвращает политику защиты от потери данных.

Получение политики защиты от потери данных клиента

Возвращает политику защиты от потери данных клиента.

Получение политики защиты от потери данных среды

Возвращает политику защиты от потери данных среды.

Получение состояния операции жизненного цикла

Возвращает текущее состояние операции жизненного цикла, возникающей после исправления среды.

Получение состояния операции среды (предварительная версия)

Используется для проверки состояния операции среды, как удаление.

Получение состояния подготовки CDS

Используется для проверки состояния операции подготовки.

Получение состояния подготовки базы данных

Используется для проверки состояния операции подготовки.

Получение среды от имени администратора

Возвращает одну среду с правами администратора.

Пользователь Принудительной синхронизации

Используется для синхронизации пользователей PowerApps с CRM.

Проверка удаления среды

Используется для проверки возможности удаления среды.

Создание базы данных CDS

Создает новый экземпляр CDS в указанной среде.

Создание политики защиты от потери данных версии 2

Создает новую политику защиты от потери данных.

Создание политики защиты от потери данных клиента

Создает новую политику защиты от потери данных клиента.

Создание политики защиты от потери данных среды

Создает политику защиты от потери данных среды.

Создание среды

Создает новую среду.

Список поддерживаемых расположений

Возвращает список расположений, где поддерживается служба BAP.

Список поддерживаемых языков среды

Возвращает список поддерживаемых языков на основе расположения.

Список политик защиты от потери данных

Возвращает список всех политик защиты от потери данных клиента и среды.

Удаление политики защиты от потери данных версии 2

Удаляет политику защиты от потери данных.

Удаление политики защиты от потери данных клиента

Удаляет политику защиты от потери данных клиента.

Удаление политики защиты от потери данных среды

Удаляет политику защиты от потери данных среды.

Удаление среды

Удаляет среду.

Вывод списка виртуальных соединителей

Возвращает список виртуальных соединителей.

Возвращаемое значение

Имя Путь Тип Описание
array of object
id
id string
virtualConnector
metadata.virtualConnector boolean
имя
metadata.name string
type
metadata.type string
iconUri
metadata.iconUri string
отображаемое имя
metadata.displayName string

Вывод списка политик защиты от потери данных версии 2

Возвращает список всех политик защиты от потери данных, к которым может получить доступ учетная запись.

Возвращаемое значение

Вывод списка разблокируемых соединителей

Возвращает список соединителей, которые не могут быть заблокированы политикой защиты от потери данных.

Возвращаемое значение

Имя Путь Тип Описание
array of object
id
id string
разблокировать
metadata.unblockable boolean

Вывод списка сред в качестве администратора

Возвращает список сред.

Параметры

Имя Ключ Обязательно Тип Описание
Версия API
api-version string

Значение даты API.

Пропуск маркера
$skiptoken string

Входные данные, используемые для получения следующей страницы ответа.

Размер страницы
$top integer

Количество сред в ответе.

Развернуть свойства
$expand string

Разрешает доступ к свойствам ответа.

Возвращаемое значение

Изменение назначения ролей среды

Задает разрешения для среды.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Версия API
api-version string

Значение даты API.

Основной адрес электронной почты
email string

Основной адрес электронной почты пользователя.

Идентификатор клиента субъекта
tenantId string

Идентификатор основного клиента пользователя.

Идентификатор основного объекта
id string

Идентификатор основного объекта пользователя.

Тип субъекта
type string

Основной тип пользователя.

Идентификатор определения роли
id string

Идентификатор определения роли. Формат: /providers/Microsoft.BusinessAppPlatform/scopes/admin/environment/{environment}/{roleName}.

id
id string

Поле идентификатора.

Возвращаемое значение

Тело
RoleAssignment

Обновление политики защиты от потери данных версии 2

Обновляет политику защиты от потери данных.

Параметры

Имя Ключ Обязательно Тип Описание
Policy
policy True string

Поле имени политики.

Версия API
api-version string

Значение даты API.

Показать имя
displayName string
Классификация соединителей по умолчанию
defaultConnectorsClassification string
classification
classification True string
id
id True string
type
type True string
имя
name True string
Тип среды политики
environmentType string
id
id True string
type
type True string
имя
name True string

Возвращаемое значение

Тело
PolicyV2

Обновление политики защиты от потери данных клиента

Обновляет поля в политике защиты от потери данных.

Параметры

Имя Ключ Обязательно Тип Описание
Policy
policy True string

Поле имени политики.

Версия API
api-version string

Значение даты API.

Отображаемое имя
displayName True string

Отображаемое имя политики API.

Версия схемы
$schema True string

Определение политики API $schema.

Тип ограничения
type True string

Тип ограничения политики оставьте пустым, чтобы применить политику ко всем средам.

Имя
name True string

Поле имени среды политики.

Идентификатор
id True string

Поле идентификатора среды политики.

Тип
type True string

Поле типа среды политики.

Тип фильтра среды
filterType True string

Параметр filterType для среды ограничения политики APIFilter1.

Описание бизнес-данных
description string

Описание группы бизнес-данных политики.

Идентификатор соединителя
id string

Поле идентификатора соединителя бизнес-данных.

Имя соединителя
name string

Поле имени соединителя бизнес-данных.

Тип соединителя
type string

Поле типа соединителя бизнес-данных.

Описание бизнес-данных
description string

Описание группы бизнес-данных, отличной от политики.

Идентификатор соединителя
id string

Поле идентификатора соединителя данных, отличных от бизнеса.

Имя соединителя
name string

Поле имени соединителя не бизнес-данных.

Тип соединителя
type string

Поле типа соединителя не бизнес-данных.

Группа по умолчанию
defaultApiGroup True string

Группировать новый соединитель автоматически добавляется.

type
type True string

Тип apiGroupRule правила политики.

apiGroup
apiGroup True string

Api API правил политики apiGroupRule параметров apiGroup.

Тип действия блокировки
type True string

Если добавить блок не требуется, оставьте пустым тип действия.

Возвращаемое значение

Тело
Policy

Обновление политики защиты от потери данных среды

Обновляет политику защиты от потери данных среды.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Policy
policy True string

Поле имени политики.

Версия API
api-version string

Значение даты API.

Отображаемое имя
displayName True string

Отображаемое имя политики API.

Версия схемы
$schema True string

Определение политики API $schema.

Имя
name True string

Поле имени среды политики.

Идентификатор
id True string

Поле идентификатора среды политики.

Тип
type True string

Поле типа среды политики.

Описание бизнес-данных
description string

Описание группы бизнес-данных политики.

Идентификатор соединителя
id string

Поле идентификатора соединителя бизнес-данных.

Имя соединителя
name string

Поле имени соединителя бизнес-данных.

Тип соединителя
type string

Поле типа соединителя бизнес-данных.

Описание бизнес-данных
description string

Описание группы бизнес-данных, отличной от политики.

Идентификатор соединителя
id string

Поле идентификатора соединителя данных, отличных от бизнеса.

Имя соединителя
name string

Поле имени соединителя не бизнес-данных.

Тип соединителя
type string

Поле типа соединителя не бизнес-данных.

Группа по умолчанию
defaultApiGroup True string

Группировать новый соединитель автоматически добавляется.

type
type True string

Тип apiGroupRule правила политики.

apiGroup
apiGroup True string

Api API правил политики apiGroupRule параметров apiGroup.

Тип действия блокировки
type True string

Если добавить блок не требуется, оставьте пустым тип действия.

Возвращаемое значение

Тело
Policy

Обновление среды

Обновляет свойства среды.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Версия API
api-version string

Значение даты API.

описание
description string
отображаемое имя
displayName string
securityGroupId
securityGroupId string

Перечисление назначений ролей среды

Возвращает список разрешений для среды без CDS для приложений.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

Перечисление поддерживаемых валют среды

Возвращает список поддерживаемых валют на основе расположения.

Параметры

Имя Ключ Обязательно Тип Описание
Местоположение
environmentLocation True string

Расположение среды.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

Тело
Currencies

Получение политики защиты от потери данных версии 2

Возвращает политику защиты от потери данных.

Параметры

Имя Ключ Обязательно Тип Описание
Policy
policy True string

Поле имени политики.

Возвращаемое значение

Тело
PolicyV2

Получение политики защиты от потери данных клиента

Возвращает политику защиты от потери данных клиента.

Параметры

Имя Ключ Обязательно Тип Описание
Policy
policy True string

Поле имени политики.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

Тело
Policy

Получение политики защиты от потери данных среды

Возвращает политику защиты от потери данных среды.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Policy
policy True string

Поле имени политики.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

Тело
Policy

Получение состояния операции жизненного цикла

Возвращает текущее состояние операции жизненного цикла, возникающей после исправления среды.

Параметры

Имя Ключ Обязательно Тип Описание
Операция жизненного цикла
lifecycleOperationId True string

Идентификатор операции жизненного цикла.

Версия API
api-version string

Значение даты API.

Получение состояния операции среды (предварительная версия)

Используется для проверки состояния операции среды, как удаление.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Операция
operationName True string

Имя операции.

Версия API
api-version string

Значение даты API.

Получение состояния подготовки CDS

Используется для проверки состояния операции подготовки.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Операция
operationName True string

Имя операции.

Версия API
api-version string

Значение даты API.

Получение состояния подготовки базы данных

Используется для проверки состояния операции подготовки.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Операция
operationName True string

Название операции. Этот весь URI будет возвращен в качестве заголовка Location из /provisionInstance и будет включать это значение.

Версия API
api-version string

Значение даты API.

Получение среды от имени администратора

Возвращает одну среду с правами администратора.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

Объект среды.

Тело
Environment

Пользователь Принудительной синхронизации

Используется для синхронизации пользователей PowerApps с CRM.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

ObjectId (идентификатор объекта)
ObjectId True string

Идентификатор объекта пользователя.

Версия API
api-version string

Значение даты API.

Проверка удаления среды

Используется для проверки возможности удаления среды.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

Создание базы данных CDS

Создает новый экземпляр CDS в указанной среде.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Базовый язык
baseLanguage integer

Любой язык, возвращаемый из языков среды списка.

Код валюты
code string

Любой код валюты, возвращаемый из валют среды списка.

Шаблоны
templates array of string

Проверенный список шаблонов CRM для передачи вызову подготовки.

Возвращаемое значение

Объект среды.

Тело
Environment

Создание политики защиты от потери данных версии 2

Создает новую политику защиты от потери данных.

Параметры

Имя Ключ Обязательно Тип Описание
Показать имя
displayName string
Классификация соединителей по умолчанию
defaultConnectorsClassification string
classification
classification True string
id
id True string
type
type True string
имя
name True string
Тип среды политики
environmentType string
id
id True string
type
type True string
имя
name True string

Возвращаемое значение

Тело
PolicyV2

Создание политики защиты от потери данных клиента

Создает новую политику защиты от потери данных клиента.

Параметры

Имя Ключ Обязательно Тип Описание
Версия API
api-version string

Значение даты API.

Отображаемое имя
displayName True string

Отображаемое имя политики API.

Версия схемы
$schema True string

Определение политики API $schema.

Тип ограничения
type True string

Тип ограничения политики оставьте пустым, чтобы применить политику ко всем средам.

Имя
name True string

Поле имени среды политики.

Идентификатор
id True string

Поле идентификатора среды политики.

Тип
type True string

Поле типа среды политики.

Тип фильтра среды
filterType True string

Параметр filterType для среды ограничения политики APIFilter1.

Описание бизнес-данных
description string

Описание группы бизнес-данных политики.

Идентификатор соединителя
id string

Поле идентификатора соединителя бизнес-данных.

Имя соединителя
name string

Поле имени соединителя бизнес-данных.

Тип соединителя
type string

Поле типа соединителя бизнес-данных.

Описание бизнес-данных
description string

Описание группы бизнес-данных, отличной от политики.

Идентификатор соединителя
id string

Поле идентификатора соединителя данных, отличных от бизнеса.

Имя соединителя
name string

Поле имени соединителя не бизнес-данных.

Тип соединителя
type string

Поле типа соединителя не бизнес-данных.

Группа по умолчанию
defaultApiGroup True string

Группировать новый соединитель автоматически добавляется.

type
type True string

Тип apiGroupRule правила политики.

apiGroup
apiGroup True string

Api API правил политики apiGroupRule параметров apiGroup.

Тип действия блокировки
type True string

Если добавить блок не требуется, оставьте пустым тип действия.

Возвращаемое значение

Тело
Policy

Создание политики защиты от потери данных среды

Создает политику защиты от потери данных среды.

Параметры

Имя Ключ Обязательно Тип Описание
Версия API
api-version string

Значение даты API.

Окружающая среда
environment True string

Имя среды.

Отображаемое имя
displayName True string

Отображаемое имя политики API.

Версия схемы
$schema True string

Определение политики API $schema.

Имя
name True string

Поле имени среды политики.

Идентификатор
id True string

Поле идентификатора среды политики.

Тип
type True string

Поле типа среды политики.

Описание бизнес-данных
description string

Описание группы бизнес-данных политики.

Идентификатор соединителя
id string

Поле идентификатора соединителя бизнес-данных.

Имя соединителя
name string

Поле имени соединителя бизнес-данных.

Тип соединителя
type string

Поле типа соединителя бизнес-данных.

Описание бизнес-данных
description string

Описание группы бизнес-данных, отличной от политики.

Идентификатор соединителя
id string

Поле идентификатора соединителя данных, отличных от бизнеса.

Имя соединителя
name string

Поле имени соединителя не бизнес-данных.

Тип соединителя
type string

Поле типа соединителя не бизнес-данных.

Группа по умолчанию
defaultApiGroup True string

Группировать новый соединитель автоматически добавляется.

type
type True string

Тип apiGroupRule правила политики.

apiGroup
apiGroup True string

Api API правил политики apiGroupRule параметров apiGroup.

Тип действия блокировки
type True string

Если добавить блок не требуется, оставьте пустым тип действия.

Возвращаемое значение

Тело
Policy

Создание среды

Создает новую среду.

Параметры

Имя Ключ Обязательно Тип Описание
Версия API
api-version True string

Значение даты API.

Местоположение
location True string

Регион, в которой развернута среда.

Отображаемое имя
displayName True string

Имя тщеславия среды.

Sku среды
environmentSku True string

Тип среды.

Возвращаемое значение

Объект среды.

Тело
Environment

Список поддерживаемых расположений

Возвращает список расположений, где поддерживается служба BAP.

Параметры

Имя Ключ Обязательно Тип Описание
Версия API
api-version string

Значение даты API.

Возвращаемое значение

Тело
Locations

Список поддерживаемых языков среды

Возвращает список поддерживаемых языков на основе расположения.

Параметры

Имя Ключ Обязательно Тип Описание
Местоположение
environmentLocation True string

Расположение среды.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

Тело
Languages

Список политик защиты от потери данных

Возвращает список всех политик защиты от потери данных клиента и среды.

Параметры

Имя Ключ Обязательно Тип Описание
Версия API
api-version string

Значение даты API.

Возвращаемое значение

Удаление политики защиты от потери данных версии 2

Удаляет политику защиты от потери данных.

Параметры

Имя Ключ Обязательно Тип Описание
Policy
policy True string

Поле имени политики.

Возвращаемое значение

response
object

Удаление политики защиты от потери данных клиента

Удаляет политику защиты от потери данных клиента.

Параметры

Имя Ключ Обязательно Тип Описание
Policy
policy True string

Поле имени политики.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

response
object

Удаление политики защиты от потери данных среды

Удаляет политику защиты от потери данных среды.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Policy
policy True string

Поле имени политики.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

response
object

Удаление среды

Удаляет среду.

Параметры

Имя Ключ Обязательно Тип Описание
Окружающая среда
environment True string

Имя среды.

Версия API
api-version string

Значение даты API.

Возвращаемое значение

response
object

Определения

ResourceArray[Policy]

Имя Путь Тип Описание
value
value array of Policy

Policy

Имя Путь Тип Описание
ИД политики
id string

Поле идентификатора политики.

Тип политики
type string

Поле типа политики.

Имя политики
name string

Поле имени политики.

Отображаемое имя
properties.displayName string

Отображаемое имя политики API.

Время создания
properties.createdTime date-time

Время создания политики API.

Кем создано:
properties.createdBy Principal[CreatedBy]

Политика, созданная объектом-субъектом.

Измененное время
properties.lastModifiedTime date-time

Время изменения политики API.

Изменено пользователем
properties.lastModifiedBy Principal[ModifiedBy]

Политика, измененная объектом-субъектом.

Версия схемы
properties.definition.$schema PolicySchema

Определение политики API $schema.

Тип
properties.definition.constraints.environmentFilter1.type string

Тип environmentFilter политики.

Окружающая среда
properties.definition.constraints.environmentFilter1.parameters.environments PolicyEnvironments

Среда политики.

Тип фильтра
properties.definition.constraints.environmentFilter1.parameters.filterType string

Параметр filterType для среды ограничения политики APIFilter1.

apiGroups
properties.definition.apiGroups PolicyApiGroups
Группа по умолчанию
properties.definition.defaultApiGroup PolicyDefaultApiGroup

Группировать новый соединитель автоматически добавляется.

правила
properties.definition.rules PolicyRules

Объект правил политики.

ResourceArray[PolicyV2]

Имя Путь Тип Описание
value
value array of PolicyV2

PolicyV2

Имя Путь Тип Описание
имя
name string
отображаемое имя
displayName string
defaultConnectorsClassification
defaultConnectorsClassification string
ConnectorGroups
connectorGroups array of object
classification
connectorGroups.classification string
connectors
connectorGroups.connectors array of object
id
connectorGroups.connectors.id string
имя
connectorGroups.connectors.name string
type
connectorGroups.connectors.type string
environmentType
environmentType string
environments
environments array of object
id
environments.id string
type
environments.type string
имя
environments.name string
id
createdBy.id string
отображаемое имя
createdBy.displayName string
createdTime
createdTime string
id
lastModifiedBy.id string
отображаемое имя
lastModifiedBy.displayName string
время последнего изменения
lastModifiedTime string
isLegacySchemaVersion
isLegacySchemaVersion boolean

ResourceArray[Среда]

Имя Путь Тип Описание
value
value array of Environment

Массив объектов значения среды.

Следующая ссылка
nextLink string

URL-адрес для получения следующей страницы списка сред.

Окружающая среда

Объект среды.

Имя Путь Тип Описание
Идентификатор
id string

Поле идентификатора среды.

Тип
type string

Поле типа среды.

Имя
name string

Поле имени среды.

Местоположение
location string

Поле расположения среды.

Указание региона Azure
properties.azureRegionHint string

Поле AzureRegionHint.

Отображаемое имя
properties.displayName string

Отображаемое имя среды.

Время создания
properties.createdTime date-time

Время создания среды.

Кем создано:
properties.createdBy Principal[CreatedBy]

Политика, созданная объектом-субъектом.

время последнего изменения
properties.lastModifiedTime date-time

Дата и время последнего обновления среды.

Изменено пользователем
properties.lastModifiedBy Principal[ModifiedBy]

Политика, измененная объектом-субъектом.

Состояние подготовки
properties.provisioningState string

Подготовка среды.

capacity
properties.capacity array of object
Тип емкости
properties.capacity.capacityType string
actualConsumption
properties.capacity.actualConsumption number
ОценкаConsumption
properties.capacity.ratedConsumption number
capacityUnit
properties.capacity.capacityUnit string
updatedOn
properties.capacity.updatedOn string
addons
properties.addons array of object
addonType
properties.addons.addonType string
Выделенных
properties.addons.allocated number
addonUnit
properties.addons.addonUnit string
Тип создания
properties.creationType string

Тип среды создания.

Sku среды
properties.environmentSku string

Идентификатор Sku среды.

Тип среды
properties.environmentType string

Тип среды.

Значение по умолчанию
properties.isDefault boolean

Среда по умолчанию или нет.

Платформа бизнес-приложений
properties.runtimeEndpoints.microsoft.BusinessAppPlatform string

Конечная точка среды выполнения BusinessAppPlatform.

Common Data Model
properties.runtimeEndpoints.microsoft.CommonDataModel string

Конечная точка среды выполнения CommonDataModel.

PowerApps
properties.runtimeEndpoints.microsoft.PowerApps string

Конечная точка среды выполнения PowerApps.

Flow
properties.runtimeEndpoints.microsoft.Flow string

Конечная точка среды выполнения потока.

Обратимое удаление времени
properties.softDeletedTime date-time

Среда softDeletedTime.

Тип
properties.linkedEnvironmentMetadata.type string

Тип метаданных среды, связанный сEnvironmentMetadata.

Идентификатор ресурса
properties.linkedEnvironmentMetadata.resourceId string

Связанная средаEnvironmentMetadata ResourceId.

Дружественное имя
properties.linkedEnvironmentMetadata.friendlyName string

Связанное окружениеEnvironmentMetadata friendlyName.

Уникальное имя
properties.linkedEnvironmentMetadata.uniqueName string

Связанная средаEnvironmentMetadata uniqueName.

Имя домена
properties.linkedEnvironmentMetadata.domainName string

Имя домена domainName связанной средыEnvironmentMetadata.

Версия
properties.linkedEnvironmentMetadata.version string

Связанная версия средыEnvironmentMetadata.

URL-адрес экземпляра
properties.linkedEnvironmentMetadata.instanceUrl string

Экземпляр Метаданных среды, связанный сEnvironmentMetadataUrl.

URL-адрес API экземпляра
properties.linkedEnvironmentMetadata.instanceApiUrl string

Связанный экземпляр СредыEnvironmentMetadataApiUrl.

Основной язык
properties.linkedEnvironmentMetadata.baseLanguage integer

Связанная средаEnvironmentMetadata baseLanguage.

Состояние экземпляра
properties.linkedEnvironmentMetadata.instanceState string

Среда linkedEnvironmentMetadata instanceState.

Время создания
properties.linkedEnvironmentMetadata.createdTime date-time

Среда linkedEnvironmentMetadata createdTime.

Измененное время
properties.linkedEnvironmentMetadata.modifiedTime date-time

Среда linkedEnvironmentMetadata modifiedTime.

Суффикс имени узла
properties.linkedEnvironmentMetadata.hostNameSuffix string

Среда linkedEnvironmentMetadata hostNameSuffix.

Идентификатор решения BAP
properties.linkedEnvironmentMetadata.bapSolutionId string

Связанная средаEnvironmentMetadata bapSolutionId.

Шаблоны создания
properties.linkedEnvironmentMetadata.creationTemplates array of string

Среда linkedEnvironmentMetadata creationTemplates.

Версия пакета управления
properties.linkedEnvironmentMetadata.managementPackageVersion string

Среда linkedEnvironmentMetadata managementPackageVersion.

ПолитикиEnvironments

Среда политики.

Имя Путь Тип Описание
Имя
name string

Поле имени среды политики.

Идентификатор
id string

Поле идентификатора среды политики.

Тип
type string

Поле типа среды политики.

PolicyRules

Объект правил политики.

Имя Путь Тип Описание
type
apiGroupRule.type string

Тип apiGroupRule правила политики.

apiGroup
apiGroupRule.parameters.apiGroup string

Api API правил политики apiGroupRule параметров apiGroup.

Тип действия блокировки
apiGroupRule.actions.blockAction.type string

Если добавить блок не требуется, оставьте пустым тип действия.

PolicySchema

Определение политики API $schema.

Определение политики API $schema.

Версия схемы
string

PolicyApiGroups

Имя Путь Тип Описание
hbi
hbi PolicyHbi

Группа Hbi политики.

lbi
lbi PolicyLbi

PolicyHbi

Группа Hbi политики.

Имя Путь Тип Описание
Описание бизнес-данных
description string

Описание группы бизнес-данных политики.

Бизнес-данные
apis array of object

API бизнес-данных.

Идентификатор соединителя
apis.id string

Поле идентификатора соединителя бизнес-данных.

Имя соединителя
apis.name string

Поле имени соединителя бизнес-данных.

Тип соединителя
apis.type string

Поле типа соединителя бизнес-данных.

PolicyLbi

Имя Путь Тип Описание
Описание бизнес-данных
description string

Описание группы бизнес-данных, отличной от политики.

Не бизнес-данные
apis array of object

API-интерфейсы бизнес-данных, отличные от бизнеса.

Идентификатор соединителя
apis.id string

Поле идентификатора соединителя данных, отличных от бизнеса.

Имя соединителя
apis.name string

Поле имени соединителя не бизнес-данных.

Тип соединителя
apis.type string

Поле типа соединителя не бизнес-данных.

PolicyDefaultApiGroup

Группировать новый соединитель автоматически добавляется.

Группировать новый соединитель автоматически добавляется.

Группа по умолчанию
string

ValidateDeleteResponse

Имя Путь Тип Описание
Может удалить
canInitiateDelete boolean

Среду можно удалить.

Массив ошибок
errors array of object

Массив ошибок

Code
errors.error.code string

Код ошибки для проверки удаления.

Message
errors.error.message string

Сообщение об ошибке.

resourcesToBeDeleted
resourcesToBeDeleted array of object
Идентификатор
resourcesToBeDeleted.id string

Ресурс для удаления идентификатора.

Имя
resourcesToBeDeleted.name string

Имя ресурса для удаления.

Тип
resourcesToBeDeleted.type string

Ресурс для удаления типа.

ResourceArray[RoleAssignment]

Имя Путь Тип Описание
value
value array of object

Массив объектов назначения ролей среды.

id
value.id string

Поле "Идентификатор назначения ролей среды".

type
value.type string

Поле типа назначения ролей среды.

имя
value.name string

Имя поля назначения ролей среды.

scope
value.properties.scope string

Область назначения ролей среды.

id
value.properties.roleDefinition.id string

Поле идентификатора роли назначения ролей среды.

type
value.properties.roleDefinition.type string

Поле типа назначения ролей средыDefinition.

имя
value.properties.roleDefinition.name string

Имя поля "Назначение роли роли среды"

id
value.properties.principal.id string

Идентификатор объекта назначения ролей среды.

отображаемое имя
value.properties.principal.displayName string

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

электронная почта
value.properties.principal.email string

Электронная почта субъекта назначения ролей среды.

type
value.properties.principal.type string

Тип субъекта назначения ролей среды.

Назначение роли

Имя Путь Тип Описание
add
add array of object

Добавление объекта назначения ролей среды.

id
add.roleAssignment.id string

Поле идентификатора идентификатора роли назначения ролей среды.

type
add.roleAssignment.type string

Поле типа назначения ролей среды.

имя
add.roleAssignment.name string

Поле имени роли назначения ролей среды.

scope
add.roleAssignment.properties.scope string

Область назначения ролей среды.

id
add.roleAssignment.properties.roleDefinition.id string

Поле идентификатора роли назначения ролей среды.

type
add.roleAssignment.properties.roleDefinition.type string

Поле идентификатора роли назначения ролей среды.

имя
add.roleAssignment.properties.roleDefinition.name string

Поле имени роли назначения ролей среды.

id
add.roleAssignment.properties.principal.id string

Идентификатор объекта назначения ролей среды.

отображаемое имя
add.roleAssignment.properties.principal.displayName string

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

электронная почта
add.roleAssignment.properties.principal.email string

Электронная почта субъекта назначения ролей среды.

type
add.roleAssignment.properties.principal.type string

Тип субъекта назначения ролей среды.

httpStatus
add.httpStatus string

HttpStatus назначения ролей среды.

Субъект[ModifiedBy]

Политика, измененная объектом-субъектом.

Имя Путь Тип Описание
Идентификатор
id string

Изменен идентификатором основного объекта.

Показать имя
displayName string

Изменено именем участника displayName.

Адрес электронной почты
email string

Изменено субъектом.

Тип
type string

Изменено по типу субъекта.

Идентификатор арендатора
tenantId string

Изменен идентификатором основного клиента.

UPN
userPrincipalName string

Изменено userPrincipalName.

Субъект[CreatedBy]

Политика, созданная объектом-субъектом.

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор основного объекта создателя политики API.

Показать имя
displayName string

Имя участника-создателя политики API.

Адрес электронной почты
email string

Электронная почта субъекта-создателя политики API.

Тип
type string

Тип субъекта-создателя политики API.

Идентификатор арендатора
tenantId string

Идентификатор клиента создателя политики API.

UPN
userPrincipalName string

Создатель политики API userPrincipalName.

Locations

Имя Путь Тип Описание
value
value array of object
Идентификатор
value.id string

Идентификатор расположения.

Имя
value.name string

Имя расположения.

Отображаемое имя
value.properties.displayName string

Отображаемое имя расположения.

Значение по умолчанию
value.properties.isDefault boolean

Расположение по умолчанию.

Отключен
value.properties.isDisabled boolean

Расположение отключено.

Валюты

Имя Путь Тип Описание
value
value array of object
Идентификатор
value.id string

Идентификатор валюты.

Имя
value.name string

Имя валюты.

Код локали
value.properties.localeId integer

Идентификатор языкового стандарта валюты.

Локализованное имя
value.properties.localizedName string

Локализованное имя валюты.

Отображаемое имя
value.properties.displayName string

Отображаемое имя валюты.

Languages

Имя Путь Тип Описание
value
value array of object
Имя
value.name string

Поле имени языка.

Идентификатор
value.id string

Поле идентификатора языка.

Тип
value.type string

Поле типа языка.

Код локали
value.properties.localeId integer

Поле идентификатора языкового стандарта.

Локализованное имя
value.properties.localizedName string

Локализованное поле имени языка.

Отображаемое имя
value.properties.displayName string

Поле отображаемого языка.

Значение по умолчанию для клиента
value.properties.isTenantDefault boolean

Язык — это поле клиента по умолчанию.

объект

Это тип object.