Domains - Update Domain
Notitie
Deze API is in preview.
Hiermee werkt u de opgegeven domeingegevens bij.
Machtigingen
De beller moet een Fabric-beheerder zijn.
Vereiste gedelegeerde bereiken
Tenant.ReadWrite.All.
Beperkingen
Maximaal 25 aanvragen per minuut per principal.
Door Microsoft Entra ondersteunde identiteiten
Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.
Identiteit | Steunen |
---|---|
Gebruiker | Ja |
service-principal en beheerde identiteiten | Ja |
Interface
PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
domain
|
path | True |
string uuid |
De domein-id. |
Aanvraagbody
Name | Type | Description |
---|---|---|
contributorsScope |
Het bereik van domeinbijdragers. |
|
description |
string |
De domeinbeschrijving. De beschrijving mag niet meer dan 256 tekens bevatten. |
displayName |
string |
De weergavenaam van het domein. De weergavenaam mag niet meer dan 40 tekens bevatten. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De aanvraag is voltooid. |
|
Other Status Codes |
Veelvoorkomende foutcodes:
|
Voorbeelden
Update a domain example
Voorbeeldaanvraag
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"
}
Voorbeeldrespons
{
"id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"displayName": "Domain's new name",
"description": "Domain's new description",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
Definities
Name | Description |
---|---|
Contributors |
Het bereik van de inzender. Er kunnen in de loop van de tijd extra inzenderbereiken worden toegevoegd. |
Domain |
Vertegenwoordigt een domein of subdomein. |
Error |
Het foutgerelateerde resourcedetailsobject. |
Error |
Het foutbericht. |
Error |
De details van het foutbericht. |
Update |
De nettolading van de aanvraag voor het bijwerken van een domein. |
ContributorsScopeType
Het bereik van de inzender. Er kunnen in de loop van de tijd extra inzenderbereiken worden toegevoegd.
Waarde | Description |
---|---|
AdminsOnly |
Alleen tenant- en domeinbeheerders. |
AllTenant |
Alle gebruikers van de tenant. |
SpecificUsersAndGroups |
Specifieke gebruikers en groepen. |
Domain
Vertegenwoordigt een domein of subdomein.
Name | Type | Description |
---|---|---|
contributorsScope |
Het bereik van domeinbijdragers. |
|
description |
string |
De beschrijving van het domein. |
displayName |
string |
De naam van het domein. |
id |
string uuid |
De domeinobject-id. |
parentDomainId |
string uuid |
De bovenliggende object-id van het domein. |
ErrorRelatedResource
Het foutgerelateerde resourcedetailsobject.
Name | Type | Description |
---|---|---|
resourceId |
string |
De resource-id die betrokken is bij de fout. |
resourceType |
string |
Het type resource dat betrokken is bij de fout. |
ErrorResponse
Het foutbericht.
Name | Type | Description |
---|---|---|
errorCode |
string |
Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is. |
message |
string |
Een leesbare weergave van de fout. |
moreDetails |
Lijst met aanvullende foutdetails. |
|
relatedResource |
De foutgerelateerde resourcedetails. |
|
requestId |
string |
Id van de aanvraag die is gekoppeld aan de fout. |
ErrorResponseDetails
De details van het foutbericht.
Name | Type | Description |
---|---|---|
errorCode |
string |
Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is. |
message |
string |
Een leesbare weergave van de fout. |
relatedResource |
De foutgerelateerde resourcedetails. |
UpdateDomainRequest
De nettolading van de aanvraag voor het bijwerken van een domein.
Name | Type | Description |
---|---|---|
contributorsScope |
Het bereik van domeinbijdragers. |
|
description |
string |
De domeinbeschrijving. De beschrijving mag niet meer dan 256 tekens bevatten. |
displayName |
string |
De weergavenaam van het domein. De weergavenaam mag niet meer dan 40 tekens bevatten. |