Skip to content

Get-FabricMLModel.md

Latest commit

 

History

History
141 lines (105 loc) · 2.99 KB

Get-FabricMLModel.md

File metadata and controls

141 lines (105 loc) · 2.99 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-FabricMLModel

Get-FabricMLModel

SYNOPSIS

Retrieves ML Model details from a specified Microsoft Fabric workspace.

SYNTAX

__AllParameterSets

Get-FabricMLModel [-WorkspaceId] <guid> [[-MLModelId] <guid>] [[-MLModelName] <string>]
 [<CommonParameters>]

ALIASES

DESCRIPTION

This function retrieves ML Model details from a specified workspace using either the provided MLModelId or MLModelName. It handles token validation, constructs the API URL, makes the API request, and processes the response.

EXAMPLES

EXAMPLE 1

This example retrieves the ML Model details for the model with ID "model-67890" in the workspace with ID "workspace-12345".

Get-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890"

EXAMPLE 2

This example retrieves the ML Model details for the model named "My ML Model" in the workspace with ID "workspace-12345".

Get-FabricMLModel -WorkspaceId "workspace-12345" -MLModelName "My ML Model"

PARAMETERS

-MLModelId

The unique identifier of the ML Model to retrieve. 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: ''

-MLModelName

The name of the ML Model to retrieve. This parameter is optional.

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

-WorkspaceId

The unique identifier of the workspace where the ML Model 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 }}