Skip to content

Get-FabricSemanticModelDefinition.md

Latest commit

 

History

History
141 lines (105 loc) · 3.26 KB

Get-FabricSemanticModelDefinition.md

File metadata and controls

141 lines (105 loc) · 3.26 KB
Raw
document type cmdlet
external help file FabricTools-Help.xml
HelpUri
Locale en-US
Module Name FabricTools
ms.date 04/01/2026
PlatyPS schema version 2024-05-01
title Get-FabricSemanticModelDefinition

Get-FabricSemanticModelDefinition

SYNOPSIS

Retrieves the definition of an SemanticModel from a specified Microsoft Fabric workspace.

SYNTAX

__AllParameterSets

Get-FabricSemanticModelDefinition [-WorkspaceId] <guid> [[-SemanticModelId] <guid>]
 [[-SemanticModelFormat] <string>] [<CommonParameters>]

ALIASES

DESCRIPTION

This function retrieves the definition of an SemanticModel from a specified workspace using the provided SemanticModelId. It handles token validation, constructs the API URL, makes the API request, and processes the response.

EXAMPLES

EXAMPLE 1

This example retrieves the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345".

Get-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890"

EXAMPLE 2

This example retrieves the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" in JSON format.

Get-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelFormat "json"

PARAMETERS

-SemanticModelFormat

The format in which to retrieve the SemanticModel definition. This parameter is optional.

Type: System.String
DefaultValue: TMDL
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SemanticModelId

The unique identifier of the SemanticModel to retrieve the definition for. This parameter is optional.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WorkspaceId

The unique identifier of the workspace where the SemanticModel exists. This parameter is mandatory.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

  • Requires $FabricConfig global configuration, including BaseUrl and FabricHeaders.
  • Calls Confirm-TokenState to ensure token validity before making the API request.

Author: Tiago Balabuch

RELATED LINKS

{{ Fill in the related links here }}