Sdílet prostřednictvím

Domains - Update Domain

  • Reference
Služba:
Admin
Verze rozhraní API:
v1

Poznámka

Toto rozhraní API je ve verzi Preview.

Aktualizuje zadané informace o doméně.

Dovolení

Volající musí být správcem prostředků infrastruktury.

Požadované delegovaná rozsahy

Tenant.ReadWrite.All.

Omezení

Maximálně 25 požadavků za jednu minutu na objekt zabezpečení.

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita Podpora
Uživatel Ano
instančního objektu a spravované identity Ano

Rozhraní

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
domainId
 path True

string

uuid

ID domény.

Text požadavku

Name Typ Description
contributorsScope

ContributorsScopeType

Obor přispěvatelů domény.
description

string

Popis domény. Popis nesmí obsahovat více než 256 znaků.
displayName

string

Zobrazovaný název domény. Zobrazovaný název nesmí obsahovat více než 40 znaků.

Odpovědi

Name Typ Description
200 OK

Domain

Žádost byla úspěšně dokončena.
Other Status Codes

ErrorResponse

Běžné kódy chyb:

  • Neznámá chyba – došlo k chybě.

  • EntityConflict – Aktualizace domény se nezdařila, protože zobrazovaný název domény již existuje.

Příklady

Update a domain example

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
ContributorsScopeType

Obor přispěvatele. V průběhu času je možné přidat další obory přispěvatelů.
Domain

Představuje doménu nebo subdoménu.
ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.
ErrorResponse

Odpověď na chybu.
ErrorResponseDetails

Podrobnosti o odpovědi na chybu.
UpdateDomainRequest

Datová část požadavku pro aktualizaci domény.

ContributorsScopeType

Výčet

Obor přispěvatele. V průběhu času je možné přidat další obory přispěvatelů.

Hodnota Description
AdminsOnly

Pouze správci tenantů a domén.
AllTenant

Všichni uživatelé tenanta.
SpecificUsersAndGroups

Konkrétní uživatelé a skupiny.

Domain

Objekt

Představuje doménu nebo subdoménu.

Name Typ Description
contributorsScope

ContributorsScopeType

Obor přispěvatelů domény.
description

string

Popis domény.
displayName

string

Název domény.
id

string

uuid

ID objektu domény.
parentDomainId

string

uuid

ID nadřazeného objektu domény.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name Typ Description
resourceId

string

ID prostředku, které je součástí chyby.
resourceType

string

Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
moreDetails

ErrorResponseDetails[]

Seznam dalších podrobností o chybě
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou
requestId

string

ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

UpdateDomainRequest

Objekt

Datová část požadavku pro aktualizaci domény.

Name Typ Description
contributorsScope

ContributorsScopeType

Obor přispěvatelů domény.
description

string

Popis domény. Popis nesmí obsahovat více než 256 znaků.
displayName

string

Zobrazovaný název domény. Zobrazovaný název nesmí obsahovat více než 40 znaků.