Del via

Domains - Update Domain

  • Referanse
Tjeneste:
Admin
API-versjon:
v1

Notat

Denne API-en er i forhåndsvisning.

Oppdaterer den angitte domeneinformasjonen.

Tillatelser

Innringeren må være en fabric-administrator.

Nødvendige delegerte omfang

Tenant.ReadWrite.All.

Begrensninger

Maksimalt 25 forespørsler per minutt per hovedstol.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet Støtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Ja

Grensesnitt

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

URI-parametere

Navn I Obligatorisk Type Beskrivelse
domainId
 path True

string

uuid

Domene-ID-en.

Brødtekst for forespørsel

Navn Type Beskrivelse
contributorsScope

ContributorsScopeType

Området for domenebidragsytere.
description

string

Domenebeskrivelsen. Beskrivelsen kan ikke inneholde mer enn 256 tegn.
displayName

string

Visningsnavnet for domenet. Visningsnavnet kan ikke inneholde mer enn 40 tegn.

Svar

Navn Type Beskrivelse
200 OK

Domain

Forespørselen er fullført.
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • UnknownError - Det oppstod en feil.

  • EntityConflict – oppdateringsdomenet mislyktes fordi domenets visningsnavn allerede finnes.

Eksempler

Update a domain example

Eksempelforespørsel

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

Eksempelsvar

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

Definisjoner

Navn Beskrivelse
ContributorsScopeType

Bidragsyteromfanget. Flere bidragsyteromfang kan legges til over tid.
Domain

Representerer et domene eller underdomene.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
UpdateDomainRequest

Forespørselsnyttelasten for oppdatering av et domene.

ContributorsScopeType

Opplisting

Bidragsyteromfanget. Flere bidragsyteromfang kan legges til over tid.

Verdi Beskrivelse
AdminsOnly

Bare leier- og domeneadministratorer.
AllTenant

Alle tenantens brukere.
SpecificUsersAndGroups

Bestemte brukere og grupper.

Domain

Object

Representerer et domene eller underdomene.

Navn Type Beskrivelse
contributorsScope

ContributorsScopeType

Området for domenebidragsytere.
description

string

Beskrivelsen av domenet.
displayName

string

Navnet på domenet.
id

string

uuid

Objekt-ID-en for domenet.
parentDomainId

string

uuid

Domenets overordnede objekt-ID.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

UpdateDomainRequest

Object

Forespørselsnyttelasten for oppdatering av et domene.

Navn Type Beskrivelse
contributorsScope

ContributorsScopeType

Området for domenebidragsytere.
description

string

Domenebeskrivelsen. Beskrivelsen kan ikke inneholde mer enn 256 tegn.
displayName

string

Visningsnavnet for domenet. Visningsnavnet kan ikke inneholde mer enn 40 tegn.