Domains - Update Domain
Seddel
Denne API er en prøveversion.
Opdaterer de angivne domæneoplysninger.
Tilladelser
Den, der ringer op, skal være Fabric-administrator.
Påkrævede delegerede områder
Tenant.ReadWrite.All.
Begrænsninger
Maksimalt 25 anmodninger pr. minut pr. hovedkonto.
Microsoft Entra-understøttede identiteter
Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.
Identitet | Støtte |
---|---|
Bruger | Ja |
tjenesteprincipal og administrerede identiteter | Ja |
Grænseflade
PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}
URI-parametre
Name | I | Påkrævet | Type | Beskrivelse |
---|---|---|---|---|
domain
|
path | True |
string uuid |
Domæne-id'et. |
Brødtekst for anmodning
Name | Type | Beskrivelse |
---|---|---|
contributorsScope |
Området for domænebidragydere. |
|
description |
string |
Domænebeskrivelsen. Beskrivelsen må ikke indeholde mere end 256 tegn. |
displayName |
string |
Det viste domænenavn. Det viste navn må ikke indeholde mere end 40 tegn. |
Svar
Name | Type | Beskrivelse |
---|---|---|
200 OK |
Anmodningen blev fuldført. |
|
Other Status Codes |
Almindelige fejlkoder:
|
Eksempler
Update a domain example
Eksempelanmodning
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
{
"id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"displayName": "Domain's new name",
"description": "Domain's new description",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
Definitioner
Name | Beskrivelse |
---|---|
Contributors |
Bidragyderområdet. Yderligere bidragyderområder kan tilføjes over tid. |
Domain |
Repræsenterer et domæne eller underdomæne. |
Error |
Objektet med fejlrelaterede ressourceoplysninger. |
Error |
Fejlsvaret. |
Error |
Oplysninger om fejlsvar. |
Update |
Nyttedata for anmodning om opdatering af et domæne. |
ContributorsScopeType
Bidragyderområdet. Yderligere bidragyderområder kan tilføjes over tid.
Værdi | Beskrivelse |
---|---|
AdminsOnly |
Kun lejer- og domæneadministratorer. |
AllTenant |
Alle lejerens brugere. |
SpecificUsersAndGroups |
Specifikke brugere og grupper. |
Domain
Repræsenterer et domæne eller underdomæne.
Name | Type | Beskrivelse |
---|---|---|
contributorsScope |
Området for domænebidragydere. |
|
description |
string |
Beskrivelsen af domænet. |
displayName |
string |
Navnet på domænet. |
id |
string uuid |
Domæneobjekt-id'et. |
parentDomainId |
string uuid |
Det overordnede objekt-id for domænet. |
ErrorRelatedResource
Objektet med fejlrelaterede ressourceoplysninger.
Name | Type | Beskrivelse |
---|---|---|
resourceId |
string |
Det ressource-id, der er involveret i fejlen. |
resourceType |
string |
Typen af ressource, der er involveret i fejlen. |
ErrorResponse
Fejlsvaret.
Name | Type | Beskrivelse |
---|---|---|
errorCode |
string |
Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere. |
message |
string |
En menneskelig læsbar gengivelse af fejlen. |
moreDetails |
Liste over yderligere oplysninger om fejl. |
|
relatedResource |
De fejlrelaterede ressourceoplysninger. |
|
requestId |
string |
Id'et for den anmodning, der er knyttet til fejlen. |
ErrorResponseDetails
Oplysninger om fejlsvar.
Name | Type | Beskrivelse |
---|---|---|
errorCode |
string |
Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere. |
message |
string |
En menneskelig læsbar gengivelse af fejlen. |
relatedResource |
De fejlrelaterede ressourceoplysninger. |
UpdateDomainRequest
Nyttedata for anmodning om opdatering af et domæne.
Name | Type | Beskrivelse |
---|---|---|
contributorsScope |
Området for domænebidragydere. |
|
description |
string |
Domænebeskrivelsen. Beskrivelsen må ikke indeholde mere end 256 tegn. |
displayName |
string |
Det viste domænenavn. Det viste navn må ikke indeholde mere end 40 tegn. |