Items - Create Semantic Model

Tjeneste:: SemanticModel

API-version:: v1

Opretter en semantisk model i det angivne arbejdsområde.
Denne API understøtter LRO-handlinger (Long Running Operations).

API'en understøtter tre oprettelsestilstande: (1) giver fuld definition kontrol over modelstrukturen, (2) indeholder url-adresser creationPayload til OneLake-tabeller for at oprette en DirectLake-model eller (3) udelader begge dele for at oprette en tom semantisk model. Brug definition eller creationPayload. Du kan ikke bruge begge dele på samme tid.

Tilladelser

Den, der ringer op, skal have en bidragyderarbejdsområderolle. Når du opretter en DirectLake-model med en creationPayload , der refererer til OneLake-tabeller, skal kalderen også have adgang til hver refereret kilde Lakehouse eller hvert dataelement, herunder når disse kilder er placeret i et andet arbejdsområde (kilder på tværs af arbejdsområder).

Påkrævede delegerede områder

SemanticModel.ReadWrite.All eller Item.ReadWrite.All

Begrænsninger

Hvis du vil oprette en semantisk model, skal brugeren have den relevante licens. Du kan få flere oplysninger under: Microsoft Fabric licenstyper.

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Navn	Påkrævet	Type	Beskrivelse
displayName	True	string	Det viste navn på den semantiske model. Det viste navn skal følge navngivningsreglerne i henhold til elementtypen.
creationPayload		SemanticModelCreationPayload	Nyttedata for oprettelse af en semantisk model uden en komplet definition. Angiv URL-adresser til OneLake-tabeller for at oprette en DirectLake-model, eller udelad begge `definition` dele, og `creationPayload` opret en tom semantisk model. Brug `definition` eller `creationPayload`. Du kan ikke bruge begge dele på samme tid.
definition		SemanticModelDefinition	Den offentlige definition af den semantiske model. Brug `definition` eller `creationPayload`. Du kan ikke bruge begge dele på samme tid.
description		string	Beskrivelse af semantisk model. Maksimumlængden er 256 tegn.
folderId		string (uuid)	Mappe-id'et. Hvis den ikke er angivet eller null, oprettes den semantiske model med arbejdsområdet som mappe.
sensitivityLabelSettings		SensitivityLabelSettings	Indstillinger for følsomhedsmærkat for den semantiske model.

Svar

Navn	Type	Beskrivelse
201 Created	SemanticModel	Oprettet
202 Accepted		Anmodningen er accepteret, semantisk modelklargøring i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: ItemDisplayNameAlreadyInUse – Det viste navn på elementet bruges allerede. CorruptedPayload – Den angivne nyttedata er beskadiget. GensidigExclusiveProperties – og `definitioncreationPayload` kan ikke begge angives. InvalidOneLakeTableUrl – En eller flere URL-adresser til OneLake-tabellen er ugyldige. DuplicateTableName – Duplikerede tabelnavne er ikke tilladt.

Eksempler

Create a semantic model example

Create a semantic model with OneLake tables example

Create an empty semantic model example

Create a semantic model example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels

{
  "displayName": "SemanticModel 1",
  "description": "A semantic model description.",
  "definition": {
    "parts": [
      {
        "path": "model.bim",
        "payload": "ew0KICAiY29tcGF0a..GVzIjogWyBdDQogIH0NCn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbism",
        "payload": "ewogICJ2ZXJzaW9uI..NldHRpbmdzIjoge30KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Eksempelsvar

Statuskode:: 201

{
  "displayName": "SemanticModel 1",
  "description": "A semantic model description.",
  "type": "SemanticModel",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a semantic model with OneLake tables example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels

{
  "displayName": "Sales Analytics Model",
  "description": "A semantic model connected to lakehouse tables.",
  "creationPayload": {
    "oneLakeTables": [
      "https://onelake.dfs.fabric.microsoft.com/aaaa0000-bb11-2222-33cc-444444dddddd/cccc0000-dd11-2222-33ee-444444ffffff/Tables/dim_customer",
      "https://onelake.dfs.fabric.microsoft.com/aaaa0000-bb11-2222-33cc-444444dddddd/cccc0000-dd11-2222-33ee-444444ffffff/Tables/sales/dim_product",
      "https://onelake.dfs.fabric.microsoft.com/1111aaaa-bb22-3333-44cc-555555eeeeee/2222bbbb-cc33-4444-55dd-666666ffffff/Tables/dim_region"
    ]
  }
}

Eksempelsvar

Statuskode:: 201

{
  "displayName": "Sales Analytics Model",
  "description": "A semantic model connected to lakehouse tables.",
  "type": "SemanticModel",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create an empty semantic model example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels

{
  "displayName": "SemanticModel 1",
  "description": "An empty semantic model."
}

Eksempelsvar

Statuskode:: 201

{
  "displayName": "SemanticModel 1",
  "description": "An empty semantic model.",
  "type": "SemanticModel",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitioner

Navn	Beskrivelse
CreateSemanticModelRequest	Opret nyttedata for semantisk modelanmodning.
EntireTenantPrincipal	Repræsenterer en lejerprincipal
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
GroupPrincipal	Repræsenterer en sikkerhedsgruppe.
GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.
ItemTag	Repræsenterer et mærke, der er anvendt på et element.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
PrincipalType	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
SemanticModel	Et semantisk modelobjekt.
SemanticModelCreationPayload	Oprettelse af nyttedata til oprettelse af en semantisk model uden en definition.
SemanticModelDefinition	offentlig definition af semantisk model objekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af semantisk model.
SemanticModelDefinitionPart	Semantisk modeldefinitionsdelsobjekt.
SensitivityLabel	Repræsenterer en følsomhedsmærkat, der er anvendt på et element.
SensitivityLabelApplyStrategy	Strategien for anvendelse af følsomhedsmærkaten. Standardværdien er ApplyOrFail. Der kan tilføjes flere typer over tid.
SensitivityLabelSettings	Indstillinger for følsomhedsmærkat.
ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
ServicePrincipalPrincipal	Repræsenterer en Microsoft Entra tjenesteprincipal.
ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Repræsenterer en tjenesteprincipalprofil.
UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.
UserPrincipal	Repræsenterer en Microsoft Entra brugerprincipal.

CreateSemanticModelRequest

Objekt

Opret nyttedata for semantisk modelanmodning.

Navn	Type	Beskrivelse
creationPayload	SemanticModelCreationPayload	Nyttedata for oprettelse af en semantisk model uden en komplet definition. Angiv URL-adresser til OneLake-tabeller for at oprette en DirectLake-model, eller udelad begge `definition` dele, og `creationPayload` opret en tom semantisk model. Brug `definition` eller `creationPayload`. Du kan ikke bruge begge dele på samme tid.
definition	SemanticModelDefinition	Den offentlige definition af den semantiske model. Brug `definition` eller `creationPayload`. Du kan ikke bruge begge dele på samme tid.
description	string	Beskrivelse af semantisk model. Maksimumlængden er 256 tegn.
displayName	string	Det viste navn på den semantiske model. Det viste navn skal følge navngivningsreglerne i henhold til elementtypen.
folderId	string (uuid)	Mappe-id'et. Hvis den ikke er angivet eller null, oprettes den semantiske model med arbejdsområdet som mappe.
sensitivityLabelSettings	SensitivityLabelSettings	Indstillinger for følsomhedsmærkat for den semantiske model.

EntireTenantPrincipal

Objekt

Repræsenterer en lejerprincipal

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
type	string: EntireTenant	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	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.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

GroupDetails

Objekt

Gruppér specifikke oplysninger. Gælder, når hovedtypen er Group.

Navn	Type	Beskrivelse
groupType	GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.

GroupPrincipal

Objekt

Repræsenterer en sikkerhedsgruppe.

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
groupDetails	GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
id	string (uuid)	Hovedprincipalens id.
type	string: Group	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

GroupType

Optælling

Gruppens type. Der kan tilføjes flere gruppetyper over tid.

Værdi	Beskrivelse
Unknown	Hovedgruppetypen er ukendt.
SecurityGroup	Principal er en sikkerhedsgruppe.
DistributionList	Principal er en distributionsliste.

ItemTag

Objekt

Repræsenterer et mærke, der er anvendt på et element.

Navn	Type	Beskrivelse
displayName	string	Navnet på mærket.
id	string (uuid)	Tag-id'et.

ItemType

Optælling

Elementets type. Der kan tilføjes flere elementtyper over tid.

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-model.
PaginatedReport	Sideinddelt PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et søhus.
Eventhouse	Et eventhouse.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
KQLDashboard	Et KQL-dashboard.
DataPipeline	En datapipeline.
Notebook	En notesbog.
SparkJobDefinition	En spark jobdefinition.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
Warehouse	Et lager.
Eventstream	En hændelsesstream.
SQLEndpoint	Et SQL-slutpunkt.
MirroredWarehouse	Et spejlvendt lager.
MirroredDatabase	En spejlet database.
Reflex	En refleks.
GraphQLApi	En API til GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Et kopijob.
VariableLibrary	En VariabelLibrary.
Dataflow	Et dataflow.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et lagersnapshot.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Et Digital Twin Builder-flow.
MirroredAzureDatabricksCatalog	Et spejlet Azure Databricks-katalog.
Map	Et kort.
AnomalyDetector	En uregelmæssighedsregistrering.
UserDataFunction	En brugerdatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	Et Graph QuerySet.
SnowflakeDatabase	En Snowflake-database til lagring af Iceberg-tabeller, der er oprettet fra Snowflake-konto.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	Et EventSchemaSet.
DataAgent	En DataAgent.
MirroredCatalog	En MirroredCatalog.
PolicySet	Et politiksæt.
AppBackend	En AppBackend.
OrgApp	En organisationsapp.
OrgAppAudience	En målgruppe for organisationsapps.
DataBuildToolJob	Et DataBuildToolJob.
AzureDatabricksStorage	Et OneLake-understøttet lagerelement til Azure Databricks.
Plan	En plan.
Monitoring	Et overvågningselement.
DeploymentPlan	En udrulningsplan.
ShareSubscription	Et shareabonnement.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

PrincipalType

Optælling

Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

Værdi	Beskrivelse
User	Principal er en Microsoft Entra brugerprincipal.
ServicePrincipal	Principal er en Microsoft Entra tjenesteprincipal.
Group	Principal er en sikkerhedsgruppe.
ServicePrincipalProfile	Principal er en tjenesteprincipalprofil.
EntireTenant	Principal repræsenterer alle lejerbrugere.

SemanticModel

Objekt

Et semantisk modelobjekt.

Navn	Type	Beskrivelse
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Elementets standardidentitet.
description	string	Elementbeskrivelsen.
displayName	string	Det viste elementnavn.
folderId	string (uuid)	Mappe-id'et.
id	string (uuid)	Element-id'et.
logicalId	string (uuid)	Elementets logiske id. Tilsvarende elementforekomster deler det samme logiske id. Værdien er null, når der ikke er tildelt noget logisk id.
sensitivityLabel	SensitivityLabel	Elementets følsomhedsmærkat.
tags	ItemTag[]	Liste over anvendte mærker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbejdsområde-id'et.

SemanticModelCreationPayload

Objekt

Oprettelse af nyttedata til oprettelse af en semantisk model uden en definition.

Navn	Type	Beskrivelse
oneLakeTables	string[] (uri)	En liste over URL-adresser til OneLake-tabeller, som den semantiske model skal forbindes med (højst 100). Hver URL-adresse skal følge et af to formater: `https://onelake.dfs.fabric.microsoft.com/{workspaceId}/{dataItemId}/Tables/{tableName}` for en tabel i standardskemaet `dbo` eller `https://onelake.dfs.fabric.microsoft.com/{workspaceId}/{dataItemId}/Tables/{schemaName}/{tableName}` for en tabel i et eksplicit brugerdefineret skema. URL-adresser kan referere til forskellige arbejdsområder og dataelementer, og en enkelt anmodning kan blande URL-adresser for standardskemaer og brugerdefinerede skemaer. Systemet udleder tabelnavne og kolonner fra OneLake-kilden.

SemanticModelDefinition

Objekt

offentlig definition af semantisk model objekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af semantisk model.

Navn	Type	Beskrivelse
format	string	Formatet af definitionen af den semantiske model.
parts	SemanticModelDefinitionPart[]	En liste over definitionsdele.

SemanticModelDefinitionPart

Objekt

Semantisk modeldefinitionsdelsobjekt.

Navn	Type	Beskrivelse
path	string	Stien til den semantiske modeldel.
payload	string	Den semantiske modeldels nyttedata.
payloadType	PayloadType	Nyttedatatypen.

SensitivityLabel

Objekt

Repræsenterer en følsomhedsmærkat, der er anvendt på et element.

Navn	Type	Beskrivelse
id	string (uuid)	Id'et for følsomhedsmærkaten.

SensitivityLabelApplyStrategy

Optælling

Strategien for anvendelse af følsomhedsmærkaten. Standardværdien er ApplyOrFail. Der kan tilføjes flere typer over tid.

Værdi	Beskrivelse
ApplyOrFail	Anvend følsomhedsmærkaten, eller handlingen mislykkes, hvis den ikke kan anvendes.
Ignore	Ignorer følsomhedsmærkaten, hvis den ikke kan anvendes, og fortsæt med handlingen uden at anvende mærkaten.

SensitivityLabelSettings

Objekt

Indstillinger for følsomhedsmærkat.

Navn	Type	Beskrivelse
labelId	string (uuid)	Id'et for følsomhedsmærkaten.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Strategien for anvendelse af følsomhedsmærkaten.

ServicePrincipalDetails

Objekt

Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipal.

Navn	Type	Beskrivelse
aadAppId	string (uuid)	Tjenesteprincipalens Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Repræsenterer en Microsoft Entra tjenesteprincipal.

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
servicePrincipalDetails	ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
type	string: ServicePrincipal	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

ServicePrincipalProfileDetails

Objekt

Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipalProfile.

Navn	Type	Beskrivelse
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Profilen for tjenesteprincipalens overordnede hoved.

ServicePrincipalProfilePrincipal

Objekt

Repræsenterer en tjenesteprincipalprofil.

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

UserDetails

Objekt

Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er User.

Navn	Type	Beskrivelse
userPrincipalName	string	Brugerens hovednavn.

UserPrincipal

Objekt

Repræsenterer en Microsoft Entra brugerprincipal.

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
type	string: User	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
userDetails	UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.