Domains - Create Domain

Servizio:

Admin

Versione API:

v1

Nota

Questa API è in anteprima.

Crea un nuovo dominio.

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

POST https://api.fabric.microsoft.com/v1/admin/domains

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
displayName	True	string	Nome visualizzato del dominio. Il nome visualizzato non può contenere più di 40 caratteri.
description		string	Descrizione del dominio. La descrizione non può contenere più di 256 caratteri.
parentDomainId		string uuid	ID oggetto padre del dominio.

Risposte

Nome	Tipo	Descrizione
201 Created	Domain	Dominio creato correttamente.
Other Status Codes	ErrorResponse	Codici di errore comuni: EntityNotFound: impossibile creare un dominio perché l'ID di dominio padre non è stato trovato. EntityConflict: la creazione di un dominio non è riuscita perché il nome visualizzato del dominio esiste già. InvalidInput: ID di dominio padre non valido.

Esempio

Create a domain example

Esempio di richiesta

HTTP

POST https://api.fabric.microsoft.com/v1/admin/domains

{
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}

Risposta di esempio

Codice di stato:

201

{
  "id": "9eba6944-daff-4441-b9b5-630ce34238fd",
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df",
  "contributorsScope": "AllTenant"
}

Definizioni

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

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.

CreateDomainRequest

Object

Payload della richiesta per la creazione di un dominio o di un sottodominio.

Nome	Tipo	Descrizione
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.
parentDomainId	string uuid	ID oggetto padre del dominio.

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.