Megosztás a következőn keresztül:

Domains - Update Domain

  • Referencia
Szolgáltatás:
Admin
API-verzió:
v1

Jegyzet

Ez az API előzetes verzióban érhető el.

Frissíti a megadott tartományadatokat.

Engedélyek

A hívónak háló-rendszergazdának kell lennie.

Kötelező delegált hatókörök

Tenant.ReadWrite.All.

Korlátozások

Legfeljebb 25 kérelem egy percenként.

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Azonosság Támogat
Felhasználó Igen
szolgáltatásnév és felügyelt identitások Igen

Interfész

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

URI-paraméterek

Name In Kötelező Típus Description
domainId
 path True

string

uuid

A tartomány azonosítója.

Kérelem törzse

Name Típus Description
contributorsScope

ContributorsScopeType

A tartomány közreműködőinek hatóköre.
description

string

A tartomány leírása. A leírás legfeljebb 256 karaktert tartalmazhat.
displayName

string

A tartomány megjelenítendő neve. A megjelenítendő név legfeljebb 40 karaktert tartalmazhat.

Válaszok

Name Típus Description
200 OK

Domain

A kérés sikeresen befejeződött.
Other Status Codes

ErrorResponse

Gyakori hibakódok:

  • UnknownError – Hiba történt.

  • EntityConflict – A tartomány frissítése nem sikerült, mert a tartománymegjelenítés neve már létezik.

Példák

Update a domain example

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
ContributorsScopeType

A közreműködői hatókör. Idővel további közreműködői hatókörök is hozzáadhatók.
Domain

Tartományt vagy altartományt jelöl.
ErrorRelatedResource

A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse

A hibaválasz.
ErrorResponseDetails

A hibaválasz részletei.
UpdateDomainRequest

A tartomány frissítésére vonatkozó hasznos adatkérés.

ContributorsScopeType

Enumerálás

A közreműködői hatókör. Idővel további közreműködői hatókörök is hozzáadhatók.

Érték Description
AdminsOnly

Csak bérlői és tartományi rendszergazdák.
AllTenant

A bérlő összes felhasználója.
SpecificUsersAndGroups

Adott felhasználók és csoportok.

Domain

Objektum

Tartományt vagy altartományt jelöl.

Name Típus Description
contributorsScope

ContributorsScopeType

A tartomány közreműködőinek hatóköre.
description

string

A tartomány leírása.
displayName

string

A tartomány neve.
id

string

uuid

A tartományobjektum azonosítója.
parentDomainId

string

uuid

A tartomány szülőobjektum-azonosítója.

ErrorRelatedResource

Objektum

A hibával kapcsolatos erőforrás-részletek objektum.

Name Típus Description
resourceId

string

A hibában érintett erőforrás-azonosító.
resourceType

string

A hibában érintett erőforrás típusa.

ErrorResponse

Objektum

A hibaválasz.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
moreDetails

ErrorResponseDetails[]

További hibaadatok listája.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.
requestId

string

A hibához társított kérés azonosítója.

ErrorResponseDetails

Objektum

A hibaválasz részletei.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.

UpdateDomainRequest

Objektum

A tartomány frissítésére vonatkozó hasznos adatkérés.

Name Típus Description
contributorsScope

ContributorsScopeType

A tartomány közreműködőinek hatóköre.
description

string

A tartomány leírása. A leírás legfeljebb 256 karaktert tartalmazhat.
displayName

string

A tartomány megjelenítendő neve. A megjelenítendő név legfeljebb 40 karaktert tartalmazhat.