Partager via

Domains - Update Domain

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

Note

Cette API est en préversion.

Met à jour les informations de domaine spécifiées.

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

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

Paramètres URI

Nom Dans Obligatoire Type Description
domainId
 path True

string

uuid

ID de domaine.

Corps de la demande

Nom Type Description
contributorsScope

ContributorsScopeType

Étendue des contributeurs de domaine.
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.

Réponses

Nom Type Description
200 OK

Domain

La demande s’est terminée avec succès.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • UnknownError : une erreur s’est produite.

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

Exemples

Update a domain example

Exemple de requête

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

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "contributorsScope": "SpecificUsersAndGroups"
}

Exemple de réponse

Code d’état:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "contributorsScope": "SpecificUsersAndGroups"
}

Définitions

Nom Description
ContributorsScopeType

Étendue du contributeur. Des étendues de contributeur supplémentaires peuvent être ajoutées au fil du temps.
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.
UpdateDomainRequest

Charge utile de la requête pour la mise à jour d’un domaine.

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.

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.

UpdateDomainRequest

Object

Charge utile de la requête pour la mise à jour d’un domaine.

Nom Type Description
contributorsScope

ContributorsScopeType

Étendue des contributeurs de domaine.
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.