Partager via

Domains - Assign Domain Workspaces By Principals

  • Référence
Service:
Admin
Version d'API:
v1

Note

Cette API est en préversion.

Affectez des espaces de travail au domaine spécifié lorsque l’un des principaux spécifiés dispose d’autorisations d’administrateur dans l’espace de travail.
Les attributions de domaine préexistantes sont remplacées, sauf si la réaffectation en bloc est bloquée par les paramètres du locataire de gestion de domaine.

Cette API prend en charge opérations longues (LRO).

Autorisations

L’appelant doit être un administrateur Fabric.

Étendues déléguées requises

Tenant.ReadWrite.All.

Limitations

Maximum 10 requêtes par minute par principal.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
principal de service et identités managées Oui

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
domainId
 path True

string

uuid

ID de domaine.

Corps de la demande

Nom Type Description
principals

Principal[]

Représente une identité ou un groupe Microsoft Entra.

Réponses

Nom Type Description
202 Accepted

L’opération est en cours

En-têtes

  • Location: string
  • Retry-After: integer
  • x-ms-operation-id: string
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • UnknownError : une erreur s’est produite.

Exemples

Assign domain workspaces example

Exemple de requête

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

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

Exemple de réponse

Code d’état:
202 
Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227
Retry-After: 30

Définitions

Nom Description
AssignDomainWorkspacesByPrincipalsRequest

Charge utile de la requête pour l’affectation d’espaces de travail à un domaine par principal.
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
GroupDetails

Détails spécifiques du groupe. Applicable lorsque le type principal est Group.
GroupType

Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.
Principal

Représente une identité ou un groupe Microsoft Entra.
PrincipalType

Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
ServicePrincipalDetails

Détails spécifiques au principal de service. Applicable lorsque le type principal est ServicePrincipal.
ServicePrincipalProfileDetails

Détails du profil du principal de service. Applicable lorsque le type principal est ServicePrincipalProfile.
UserDetails

Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est User.

AssignDomainWorkspacesByPrincipalsRequest

Object

Charge utile de la requête pour l’affectation d’espaces de travail à un domaine par principal.

Nom Type Description
principals

Principal[]

Représente une identité ou un groupe Microsoft Entra.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

GroupDetails

Object

Détails spécifiques du groupe. Applicable lorsque le type principal est Group.

Nom Type Description
groupType

GroupType

Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

GroupType

Énumération

Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
DistributionList

Principal est une liste de distribution.
SecurityGroup

Principal est un groupe de sécurité.
Unknown

Le type de groupe principal est inconnu.

Principal

Object

Représente une identité ou un groupe Microsoft Entra.

Nom Type Description
displayName

string

Nom complet du principal.
groupDetails

GroupDetails

Détails spécifiques du groupe. Applicable lorsque le type principal est Group.
id

string

uuid

ID du principal.
servicePrincipalDetails

ServicePrincipalDetails

Détails spécifiques au principal de service. Applicable lorsque le type principal est ServicePrincipal.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Détails du profil du principal de service. Applicable lorsque le type principal est ServicePrincipalProfile.
type

PrincipalType

Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
userDetails

UserDetails

Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est User.

PrincipalType

Énumération

Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Group

Principal est un groupe de sécurité.
ServicePrincipal

Principal est un principal de service Microsoft Entra.
ServicePrincipalProfile

Le principal est un profil de principal de service.
User

Principal est un principal d’utilisateur Microsoft Entra.

ServicePrincipalDetails

Object

Détails spécifiques au principal de service. Applicable lorsque le type principal est ServicePrincipal.

Nom Type Description
aadAppId

string

uuid

Microsoft EntraId du principal de service.

ServicePrincipalProfileDetails

Object

Détails du profil du principal de service. Applicable lorsque le type principal est ServicePrincipalProfile.

Nom Type Description
parentPrincipal

Principal

Principal parent du profil de principal de service.

UserDetails

Object

Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est User.

Nom Type Description
userPrincipalName

string

Nom d’utilisateur principal.