Partager via

Domains - Create Domain

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

Note

Cette API est en préversion.

Crée un domaine.

Autorisations

L’appelant doit être un administrateur Fabric.

Étendues déléguées requises

Tenant.ReadWrite.All.

Limitations

Maximum 25 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

Corps de la demande

Nom Obligatoire Type Description
displayName True

string

Nom complet du domaine. Le nom complet ne peut pas contenir plus de 40 caractères.
description

string

Description du domaine. La description ne peut pas contenir plus de 256 caractères.
parentDomainId

string

uuid

ID d’objet parent du domaine.

Réponses

Nom Type Description
201 Created

Domain

Domaine créé avec succès.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • EntityNotFound - Échec de la création d’un domaine, car l’ID de domaine parent est introuvable.

  • EntityConflict - Échec de la création d’un domaine, car le nom d’affichage du domaine existe déjà.

  • InvalidInput : ID de domaine parent non valide.

Exemples

Create a domain example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/admin/domains

{
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}

Exemple de réponse

Code d’état:
201 
{
  "id": "9eba6944-daff-4441-b9b5-630ce34238fd",
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df",
  "contributorsScope": "AllTenant"
}

Définitions

Nom Description
ContributorsScopeType

Étendue du contributeur. Des étendues de contributeur supplémentaires peuvent être ajoutées au fil du temps.
CreateDomainRequest

Charge utile de la requête pour la création d’un domaine ou d’un sous-domaine.
Domain

Représente un domaine ou un sous-domaine.
ErrorRelatedResource

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

Réponse d’erreur.
ErrorResponseDetails

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

ContributorsScopeType

Énumération

Étendue du contributeur. Des étendues de contributeur supplémentaires peuvent être ajoutées au fil du temps.

Valeur Description
AdminsOnly

Administrateurs de locataire et de domaine uniquement.
AllTenant

Tous les utilisateurs du locataire.
SpecificUsersAndGroups

Utilisateurs et groupes spécifiques.

CreateDomainRequest

Object

Charge utile de la requête pour la création d’un domaine ou d’un sous-domaine.

Nom Type Description
description

string

Description du domaine. La description ne peut pas contenir plus de 256 caractères.
displayName

string

Nom complet du domaine. Le nom complet ne peut pas contenir plus de 40 caractères.
parentDomainId

string

uuid

ID d’objet parent du domaine.

Domain

Object

Représente un domaine ou un sous-domaine.

Nom Type Description
contributorsScope

ContributorsScopeType

Étendue des contributeurs de domaine.
description

string

Description du domaine.
displayName

string

Nom du domaine.
id

string

uuid

ID d’objet de domaine.
parentDomainId

string

uuid

ID d’objet parent du domaine.

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.