Domains - Update Domain

Servizio:

Admin

Versione API:

v1

Nota

Questa API è in anteprima.

Aggiorna le informazioni di dominio specificate.

Autorizzazioni

Il chiamante deve essere un amministratore di Fabric.

Ambiti delegati obbligatori

Tenant.ReadWrite.All.

Limitazioni

Massimo 25 richieste per minuto per ogni entità.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Appoggiare
Utente	Sì
'entità servizio e identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
domainId	path	True	string uuid	ID di dominio.

Corpo della richiesta

Nome	Tipo	Descrizione
contributorsScope	ContributorsScopeType	Ambito dei collaboratori al dominio.
description	string	Descrizione del dominio. La descrizione non può contenere più di 256 caratteri.
displayName	string	Nome visualizzato del dominio. Il nome visualizzato non può contenere più di 40 caratteri.

Risposte

Nome	Tipo	Descrizione
200 OK	Domain	Richiesta completata correttamente.
Other Status Codes	ErrorResponse	Codici di errore comuni: UnknownError: si è verificato un errore. EntityConflict: il dominio di aggiornamento non è riuscito perché il nome visualizzato del dominio esiste già.

Esempio

Update a domain example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
ContributorsScopeType	Ambito collaboratore. È possibile aggiungere altri ambiti di collaboratore nel tempo.
Domain	Rappresenta un dominio o un sottodominio.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
UpdateDomainRequest	Payload della richiesta per l'aggiornamento di un dominio.

ContributorsScopeType

Enumeration

Ambito collaboratore. È possibile aggiungere altri ambiti di collaboratore nel tempo.

Valore	Descrizione
AdminsOnly	Solo amministratori tenant e dominio.
AllTenant	Tutti gli utenti del tenant.
SpecificUsersAndGroups	Utenti e gruppi specifici.

Domain

Object

Rappresenta un dominio o un sottodominio.

Nome	Tipo	Descrizione
contributorsScope	ContributorsScopeType	Ambito dei collaboratori al dominio.
description	string	Descrizione del dominio.
displayName	string	Nome del dominio.
id	string uuid	ID oggetto di dominio.
parentDomainId	string uuid	ID oggetto padre del dominio.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

UpdateDomainRequest

Object

Payload della richiesta per l'aggiornamento di un dominio.

Nome	Tipo	Descrizione
contributorsScope	ContributorsScopeType	Ambito dei collaboratori al dominio.
description	string	Descrizione del dominio. La descrizione non può contenere più di 256 caratteri.
displayName	string	Nome visualizzato del dominio. Il nome visualizzato non può contenere più di 40 caratteri.