Domains - Role Assignments Bulk Unassign

Служба:: Admin

Версия API:: v1

Отмените назначение указанных администраторов или участников из домена.

Permissions

Вызывающий объект должен быть администратором Fabric.

Обязательные делегированные области

Tenant.ReadWrite.All.

Limitations

Не более 25 запросов в одну минуту на участника.

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Identity	Support
User	Yes
Представитель службы и управляемые удостоверения	Yes

Interface

POST https://api.fabric.microsoft.com/v1/admin/domains/{domainId}/roleAssignments/bulkUnassign

Параметры URI

Имя	В	Обязательно	Тип	Описание
domainId	path	True	string (uuid)	Идентификатор домена.

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

Имя	Обязательно	Тип	Описание
type	True	DomainRole	Тип запроса обновления.
principals		Principal[]: UserPrincipal[] ServicePrincipalPrincipal[] GroupPrincipal[] ServicePrincipalProfilePrincipal[] EntireTenantPrincipal[]	Субъекты, которые будут не назначены из роли домена.

Ответы

Имя Тип Описание

200 OK

Имя	Тип	Описание
200 OK		Запрос успешно завершен.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: PrincipalWithDomainRoleAssignmentNotFound — субъект не назначается домену с указанной ролью. UnsupportedPrincipalTypeForDomainAdminAssignment — использование неподдерживаемого типа субъекта для назначения или отмены назначения ролей администратора домена. UnknownError — произошла ошибка.

Запрос успешно завершен.

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

PrincipalWithDomainRoleAssignmentNotFound — субъект не назначается домену с указанной ролью.
UnsupportedPrincipalTypeForDomainAdminAssignment — использование неподдерживаемого типа субъекта для назначения или отмены назначения ролей администратора домена.
UnknownError — произошла ошибка.

Примеры

Unassign domain admins example

Unassign domain contributors example

Unassign domain admins example

Образец запроса

HTTP

POST https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f/roleAssignments/bulkUnassign

{
  "type": "Admins",
  "principals": [
    {
      "id": "796ce6ad-9163-4c16-9559-c68192a251de",
      "type": "User"
    }
  ]
}

Пример ответа

Код состояния:: 200

Unassign domain contributors example

Образец запроса

HTTP

POST https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f/roleAssignments/bulkUnassign

{
  "type": "Contributors",
  "principals": [
    {
      "id": "796ce6ad-9163-4c16-9559-c68192a251de",
      "type": "User"
    }
  ]
}

Пример ответа

Код состояния:: 200

Определения

Имя	Описание
DomainRole	Представляет члены домена по типу запроса субъекта. С течением времени могут добавляться дополнительные типы запросов.
DomainRoleUnassignmentRequest	Полезные данные запроса для отмены назначения членов домена по субъекту.
EntireTenantPrincipal	Представляет субъект клиента
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
GroupPrincipal	Представляет группу безопасности.
GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.
PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
ServicePrincipalPrincipal	Представляет субъект-службу Microsoft Entra.
ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Представляет профиль субъекта-службы.
UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.
UserPrincipal	Представляет субъект пользователя Microsoft Entra.

DomainRole

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

Представляет члены домена по типу запроса субъекта. С течением времени могут добавляться дополнительные типы запросов.

Значение	Описание
Admin	Администратор домена.
Contributor	Участник домена.

DomainRoleUnassignmentRequest

Объект

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

Имя	Тип	Описание
principals	Principal[]: EntireTenantPrincipal[] GroupPrincipal[] ServicePrincipalPrincipal[] ServicePrincipalProfilePrincipal[] UserPrincipal[]	Субъекты, которые будут не назначены из роли домена.
type	DomainRole	Тип запроса обновления.

EntireTenantPrincipal

Объект

Представляет субъект клиента

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
type	string: EntireTenant	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

GroupDetails

Объект

Группировка конкретных сведений. Применимо, если тип субъекта Group.

Имя	Тип	Описание
groupType	GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.

GroupPrincipal

Объект

Представляет группу безопасности.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
groupDetails	GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
id	string (uuid)	Идентификатор субъекта.
type	string: Group	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

GroupType

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

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

Значение	Описание
Unknown	Тип основной группы неизвестен.
SecurityGroup	Субъект — это группа безопасности.
DistributionList	Субъект — это список рассылки.

PrincipalType

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

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

Значение	Описание
User	Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal	Субъект является субъектом-службой Microsoft Entra.
Group	Субъект — это группа безопасности.
ServicePrincipalProfile	Субъект — это профиль субъекта-службы.
EntireTenant	Субъект представляет всех пользователей клиента.

ServicePrincipalDetails

Объект

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

Имя	Тип	Описание
aadAppId	string (uuid)	Microsoft Entra AppId субъекта-службы.

ServicePrincipalPrincipal

Объект

Представляет субъект-службу Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalDetails	ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
type	string: ServicePrincipal	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ServicePrincipalProfileDetails

Объект

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя	Тип	Описание
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Родительский субъект профиля субъекта-службы.

ServicePrincipalProfilePrincipal

Объект

Представляет профиль субъекта-службы.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

UserDetails

Объект

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

Имя	Тип	Описание
userPrincipalName	string	Имя участника-пользователя.

UserPrincipal

Объект

Представляет субъект пользователя Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
type	string: User	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
userDetails	UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.