Skip to content

Get-FabricNotebook.md

Latest commit

 

History

History
138 lines (102 loc) · 2.74 KB

Get-FabricNotebook.md

File metadata and controls

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

Get-FabricNotebook

SYNOPSIS

Retrieves an Notebook or a list of Notebooks from a specified workspace in Microsoft Fabric.

SYNTAX

__AllParameterSets

Get-FabricNotebook [-WorkspaceId] <guid> [[-NotebookId] <guid>] [[-NotebookName] <string>]
 [<CommonParameters>]

ALIASES

DESCRIPTION

The Get-FabricNotebook function sends a GET request to the Fabric API to retrieve Notebook details for a given workspace. It can filter the results by NotebookName.

EXAMPLES

EXAMPLE 1

Retrieves the "Development" Notebook from workspace "12345".

Get-FabricNotebook -WorkspaceId "12345" -NotebookName "Development"

EXAMPLE 2

Retrieves all Notebooks in workspace "12345".

Get-FabricNotebook -WorkspaceId "12345"

PARAMETERS

-NotebookId

(Optional) The ID of a specific Notebook to retrieve.

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

-NotebookName

(Optional) The name of the specific Notebook to retrieve.

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

(Mandatory) The ID of the workspace to query Notebooks.

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, Kamil Nowinski

RELATED LINKS

{{ Fill in the related links here }}