Freigeben über

Domains - Update Domain

  • Referenz
Dienst:
Admin
API-Version:
v1

Anmerkung

Diese API befindet sich in der Vorschau.

Aktualisiert die angegebenen Domäneninformationen.

Erlaubnisse

Der Aufrufer muss ein Fabric-Administrator sein.

Erforderliche delegierte Bereiche

Tenant.ReadWrite.All.

Begrenzungen

Maximal 25 Anforderungen pro Minute pro Prinzipal.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützen
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
domainId
 path True

string

uuid

Die Domänen-ID.

Anforderungstext

Name Typ Beschreibung
contributorsScope

ContributorsScopeType

Der Bereich der Domänenmitwirkenden.
description

string

Die Domänenbeschreibung. Die Beschreibung darf nicht mehr als 256 Zeichen enthalten.
displayName

string

Der Anzeigename der Domäne. Der Anzeigename darf nicht mehr als 40 Zeichen enthalten.

Antworten

Name Typ Beschreibung
200 OK

Domain

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Ein Fehler ist aufgetreten.

  • EntityConflict – Fehler beim Aktualisieren der Domäne, da der Anzeigename der Domäne bereits vorhanden ist.

Beispiele

Update a domain example

Beispielanforderung

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"
}

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ContributorsScopeType

Der Bereich "Mitwirkender". Zusätzliche Mitwirkendebereiche können im Laufe der Zeit hinzugefügt werden.
Domain

Stellt eine Domäne oder Unterdomäne dar.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
UpdateDomainRequest

Die Anforderungsnutzlast zum Aktualisieren einer Domäne.

ContributorsScopeType

Enumeration

Der Bereich "Mitwirkender". Zusätzliche Mitwirkendebereiche können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
AdminsOnly

Nur Mandanten- und Domänenadministratoren.
AllTenant

Alle Benutzer des Mandanten.
SpecificUsersAndGroups

Bestimmte Benutzer und Gruppen.

Domain

Objekt

Stellt eine Domäne oder Unterdomäne dar.

Name Typ Beschreibung
contributorsScope

ContributorsScopeType

Der Bereich der Domänenmitwirkenden.
description

string

Die Beschreibung der Domäne.
displayName

string

Der Name der Domäne.
id

string

uuid

Die Domänenobjekt-ID.
parentDomainId

string

uuid

Die id des übergeordneten Domänenobjekts.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

UpdateDomainRequest

Objekt

Die Anforderungsnutzlast zum Aktualisieren einer Domäne.

Name Typ Beschreibung
contributorsScope

ContributorsScopeType

Der Bereich der Domänenmitwirkenden.
description

string

Die Domänenbeschreibung. Die Beschreibung darf nicht mehr als 256 Zeichen enthalten.
displayName

string

Der Anzeigename der Domäne. Der Anzeigename darf nicht mehr als 40 Zeichen enthalten.