diff --git a/.build/tasks/generateHelp.Microsoft.PowerShell.PlatyPS.build.ps1 b/.build/tasks/generateHelp.Microsoft.PowerShell.PlatyPS.build.ps1 new file mode 100644 index 00000000..6cb8996e --- /dev/null +++ b/.build/tasks/generateHelp.Microsoft.PowerShell.PlatyPS.build.ps1 @@ -0,0 +1,144 @@ +param +( + [Parameter()] + [System.IO.DirectoryInfo] + $ProjectPath = (property ProjectPath $BuildRoot), + + [Parameter()] + [System.String] + $ProjectName = (property ProjectName ''), + + [Parameter()] + [System.String] + $SourcePath = (property SourcePath ''), + + [Parameter()] + [System.String] + $HelpSourceFolder = (property HelpSourceFolder 'docs'), + + [Parameter()] + [System.String] + $OutputDirectory = (property OutputDirectory 'output'), + + [Parameter()] + [System.String] + $BuiltModuleSubdirectory = (property BuiltModuleSubdirectory ''), + + [Parameter()] + [System.Management.Automation.SwitchParameter] + $VersionedOutputDirectory = (property VersionedOutputDirectory $true), + + [Parameter()] + [System.String] + $HelpOutputFolder = (property HelpOutputFolder 'help'), + + [Parameter()] + [cultureInfo] + $HelpCultureInfo = 'en-US', + + [Parameter()] + [System.Management.Automation.SwitchParameter] + $CopyHelpMamlToBuiltModuleBase = (property CopyHelpMamlToBuiltModuleBase $true), + + # Build Configuration object + [Parameter()] + [System.Collections.Hashtable] + $BuildInfo = (property BuildInfo @{ }) +) + +function Get-GenerateHelpPSVariables +{ + param () + + $script:PesterOutputFolder = Get-SamplerAbsolutePath -Path $PesterOutputFolder -RelativeTo $OutputDirectory + + "`tPester Output Folder = '$PesterOutputFolder" + + $script:HelpSourceFolder = Get-SamplerAbsolutePath -Path $HelpSourceFolder -RelativeTo $ProjectPath + "`tHelp Source Folder = '$HelpSourceFolder'" + + $script:HelpOutputFolder = Get-SamplerAbsolutePath -Path $HelpOutputFolder -RelativeTo $OutputDirectory + "`tHelp output Folder = '$HelpOutputFolder'" + + if ($ModuleVersion) + { + $script:HelpOutputVersionFolder = Get-SamplerAbsolutePath -Path $ModuleVersion -RelativeTo $HelpOutputFolder + } + + "`tHelp output Version Folder = '$HelpOutputVersionFolder'" + + $script:HelpOutputCultureFolder = Get-SamplerAbsolutePath -Path $HelpCultureInfo -RelativeTo $HelpOutputVersionFolder + "`tHelp output Culture path = '$HelpOutputCultureFolder'" + + $script:DocOutputFolder = Get-SamplerAbsolutePath -Path 'docs' -RelativeTo $OutputDirectory + "`tDocs output folder path = '$DocOutputFolder'" +} + +# Synopsis: Produces markdown help files from the built module. +task Generate_help_from_built_module { + . Set-SamplerTaskVariable + + Get-GenerateHelpPSVariables + + $generateHelpCommands = @" + `$env:PSModulePath = '$Env:PSModulePath' + `$targetModule = Import-Module -Name '$ProjectName' -ErrorAction Stop -Passthru + + `$helpDestination = Join-Path '$HelpSourceFolder' -ChildPath '$HelpCultureInfo' + + if (!(Test-Path -Path `$helpDestination)) { + New-Item -Path `$helpDestination -ItemType Directory -Force -ErrorAction Ignore | Out-Null + } + + `$docOutputFolder = Join-Path '$DocOutputFolder' -ChildPath '$ProjectName' + + `$commandsArray = @() + foreach (`$publicFunction in `$targetModule.ExportedFunctions.Keys) { + `$command = Get-Command -Name `$publicFunction -Module `$targetModule + + `$newMarkdownCommandHelpParams = @{ + CommandInfo = `$command + OutputFolder = '$DocOutputFolder' + HelpVersion = `$targetModule.Version + Locale = '$HelpCultureInfo' + Encoding = 'utf8' + Force = `$true + } + `$Output = New-MarkdownCommandHelp @newMarkdownCommandHelpParams + + `$helpCommand = Import-MarkdownCommandHelp -Path `$Output -ErrorAction Ignore + + # Add the command to the array + `$commandsArray += `$helpCommand + + `$alias = Get-Alias -Definition `$command.Name -ErrorAction Ignore + + if (`$alias) { + `$helpCommand.Aliases = @(`$alias.Name) + } else { + `$helpCommand.Aliases = @() + } + + `$helpCommand | Export-MarkdownCommandHelp -OutputFolder '$DocOutputFolder' -Force + + Copy-Item -Path `$Output -Destination `$helpDestination -Force + } + + `$newMarkdownModuleFileParams = @{ + CommandHelp = `$commandsArray + OutputFolder = '$DocOutputFolder' + Force = `$true + } + `$markdownFile = New-MarkdownModuleFile @newMarkdownModuleFileParams + + if (`$markdownFile) { + Copy-Item -Path `$markdownFile -Destination `$helpDestination -Force + } + +"@ + Write-Build -Color DarkGray -Text "$generateHelpCommands" + $sb = [ScriptBlock]::create($generateHelpCommands) + + $pwshPath = (Get-Process -Id $PID).Path + &$pwshPath -Command $sb -ExecutionPolicy 'ByPass' +} diff --git a/CHANGELOG.md b/CHANGELOG.md index 4701f64e..1fda44ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `Start-FabricDeploymentPipelineStage` - Added private function `Get-FabricContinuationToken` to facilitate pagination - `Invoke-FabricRestMethod` handles throttling (error 429) by pausing and repeating the request (#88) +- New build automation task added `Generate_help_from_built_module` ### Changed @@ -40,6 +41,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - All Deployment Pipeline functions raise an error when an exception is caught. Used splatting for params. - Refactored SQL Database functions to use enhanced capability in `Invoke-FabricRestMethod`. Used splatting for params. - `Write-Message` uses PSFramework function for logging, which logs function name (#84) +- Changed the `documentation` folder to `docs/` +- Code-fenced blocks included in function examples ### Fixed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c3f1bad..738027e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ The workflow for using this and developing the code is shown below. 3. Start a fresh new PowerShell session to avoid anythjing from your current working sessions to interfere with the module development and building. Develop your updates in the source directory. -You should also resolve all dependencies before you start developing. This will ensure that you have all the required modules, and only them, installed and loaded into your session. + You should also resolve all dependencies before you start developing. This will ensure that you have all the required modules, and only them, installed and loaded into your session. ```PowerShell .\build.ps1 -ResolveDependency -Tasks noop -UsePSResourceGet @@ -105,7 +105,14 @@ You should also resolve all dependencies before you start developing. This will ### Fixed - Fixed issue with `New-FabricDataPipeline` not working correctly. ``` -9. Once you are happy with your code and you have updated the changelog, push your branch to GitHub and create a PR against the repo. + +10. Once you are happy with your code and you have updated the changelog, there is one thing left to do, which is documentation. To run the generation of the documentation, the `build.ps1` can leverage the `Generate_help_from_built_module` task: + + ```powershell + ./build.ps1 -Tasks Generate_help_from_built_module + ``` + +11. When the process finishes, the documentation should be updated. Now push your branch to GitHub and create a PR against the repo. ## Thanks! diff --git a/RequiredModules.psd1 b/RequiredModules.psd1 index b3783f10..a784ca5c 100644 --- a/RequiredModules.psd1 +++ b/RequiredModules.psd1 @@ -11,17 +11,23 @@ # Repository = 'PSGallery' # } #} - Assert = "0.9.6" - InvokeBuild = 'latest' - PSScriptAnalyzer = '1.19.1' - Pester = 'latest' - ModuleBuilder = 'latest' - ChangelogManagement = 'latest' - Sampler = 'latest' - 'Sampler.GitHubTasks' = 'latest' - MarkdownLinkCheck = 'latest' - PSFramework = 'latest' - 'Az.Accounts' = '5.0.0' - 'Az.Resources' = '6.15.1' - 'MicrosoftPowerBIMgmt' = '1.2.1111' + Assert = "0.9.6" + InvokeBuild = 'latest' + PSScriptAnalyzer = '1.19.1' + Pester = 'latest' + ModuleBuilder = 'latest' + ChangelogManagement = 'latest' + Sampler = 'latest' + 'Sampler.GitHubTasks' = 'latest' + MarkdownLinkCheck = 'latest' + PSFramework = 'latest' + 'Az.Accounts' = '5.0.0' + 'Az.Resources' = '6.15.1' + 'MicrosoftPowerBIMgmt' = '1.2.1111' + 'Microsoft.PowerShell.PlatyPS' = @{ + Version = '1.0.0-rc1' + Parameters = @{ + AllowPrerelease = $true + } # TODO: Simply remove after GA + } } diff --git a/build.yaml b/build.yaml index f6069d26..bcc9751c 100644 --- a/build.yaml +++ b/build.yaml @@ -52,7 +52,6 @@ BuildWorkflow: - Build_NestedModules_ModuleBuilder - Create_changelog_release_output - pack: - build - package_module_nupkg diff --git a/docs/en-US/Add-FabricDomainWorkspaceAssignmentByCapacity.md b/docs/en-US/Add-FabricDomainWorkspaceAssignmentByCapacity.md new file mode 100644 index 00000000..8d38909d --- /dev/null +++ b/docs/en-US/Add-FabricDomainWorkspaceAssignmentByCapacity.md @@ -0,0 +1,110 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Add-FabricDomainWorkspaceAssignmentByCapacity +--- + +# Add-FabricDomainWorkspaceAssignmentByCapacity + +## SYNOPSIS + +Assigns workspaces to a Fabric domain based on specified capacities. + +## SYNTAX + +### __AllParameterSets + +``` +Add-FabricDomainWorkspaceAssignmentByCapacity [-DomainId] [-CapacitiesIds] + [] +``` + +## ALIASES + +Assign-FabricDomainWorkspaceByCapacity + +## DESCRIPTION + +The `Add-FabricDomainWorkspaceAssignmentByCapacity` function assigns workspaces to a Fabric domain using a list of capacity IDs by making a POST request to the relevant API endpoint. + +## EXAMPLES + +### EXAMPLE 1 + +Assigns workspaces to the domain with ID "12345" based on the specified capacities. + +```powershell +Add-FabricDomainWorkspaceAssignmentByCapacity -DomainId "12345" -CapacitiesIds @("capacity1", "capacity2") +``` + +## PARAMETERS + +### -CapacitiesIds + +An array of capacity IDs used to assign workspaces to the domain. + +```yaml +Type: System.Guid[] +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainId + +The unique identifier of the Fabric domain to which the workspaces will be assigned. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Add-FabricDomainWorkspaceAssignmentById.md b/docs/en-US/Add-FabricDomainWorkspaceAssignmentById.md new file mode 100644 index 00000000..07d255bf --- /dev/null +++ b/docs/en-US/Add-FabricDomainWorkspaceAssignmentById.md @@ -0,0 +1,112 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Add-FabricDomainWorkspaceAssignmentById +--- + +# Add-FabricDomainWorkspaceAssignmentById + +## SYNOPSIS + +Assigns workspaces to a specified domain in Microsoft Fabric by their IDs. + +## SYNTAX + +### __AllParameterSets + +``` +Add-FabricDomainWorkspaceAssignmentById [-DomainId] [-WorkspaceIds] + [] +``` + +## ALIASES + +Assign-FabricDomainWorkspaceById + +## DESCRIPTION + +The `Add-FabricDomainWorkspaceAssignmentById` function sends a request to assign multiple workspaces to a specified domain using the provided domain ID and an array of workspace IDs. + +## EXAMPLES + +### EXAMPLE 1 + +Assigns the workspaces with IDs "ws1", "ws2", and "ws3" to the domain with ID "12345". + +```powershell +Add-FabricDomainWorkspaceAssignmentById -DomainId "12345" -WorkspaceIds @("ws1", "ws2", "ws3") +``` + +## PARAMETERS + +### -DomainId + +The ID of the domain to which workspaces will be assigned. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceIds + +An array of workspace IDs to be assigned to the domain. +This parameter is mandatory. + +```yaml +Type: System.Guid[] +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Add-FabricDomainWorkspaceAssignmentByPrincipal.md b/docs/en-US/Add-FabricDomainWorkspaceAssignmentByPrincipal.md new file mode 100644 index 00000000..6aa6bee8 --- /dev/null +++ b/docs/en-US/Add-FabricDomainWorkspaceAssignmentByPrincipal.md @@ -0,0 +1,117 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Add-FabricDomainWorkspaceAssignmentByPrincipal +--- + +# Add-FabricDomainWorkspaceAssignmentByPrincipal + +## SYNOPSIS + +Assigns workspaces to a domain based on principal IDs in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Add-FabricDomainWorkspaceAssignmentByPrincipal [-DomainId] [-PrincipalIds] + [] +``` + +## ALIASES + +Assign-FabricDomainWorkspaceByPrincipal + +## DESCRIPTION + +The `Add-FabricDomainWorkspaceAssignmentByPrincipal` function sends a request to assign workspaces to a specified domain using a JSON object of principal IDs and types. + +## EXAMPLES + +### EXAMPLE 1 + +This example assigns workspaces to a domain using a list of principal IDs and types. + +```powershell +$PrincipalIds = @( + @{id = "813abb4a-414c-4ac0-9c2c-bd17036fd58c"; type = "User"}, + @{id = "b5b9495c-685a-447a-b4d3-2d8e963e6288"; type = "User"} +) + +Add-FabricDomainWorkspaceAssignmentByPrincipal -DomainId "12345" -PrincipalIds $PrincipalIds +``` + +## PARAMETERS + +### -DomainId + +The ID of the domain to which workspaces will be assigned. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PrincipalIds + +An array representing the principals with their `id` and `type` properties. +Must contain a `principals` key with an array of objects. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Add-FabricDomainWorkspaceRoleAssignment.md b/docs/en-US/Add-FabricDomainWorkspaceRoleAssignment.md new file mode 100644 index 00000000..54f770d4 --- /dev/null +++ b/docs/en-US/Add-FabricDomainWorkspaceRoleAssignment.md @@ -0,0 +1,138 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Add-FabricDomainWorkspaceRoleAssignment +--- + +# Add-FabricDomainWorkspaceRoleAssignment + +## SYNOPSIS + +Bulk assigns roles to principals for workspaces in a Fabric domain. + +## SYNTAX + +### __AllParameterSets + +``` +Add-FabricDomainWorkspaceRoleAssignment [-DomainId] [-DomainRole] + [-PrincipalIds] [] +``` + +## ALIASES + +Assign-FabricDomainWorkspaceRoleAssignment + +## DESCRIPTION + +The `AssignFabricDomainWorkspaceRoleAssignment` function performs bulk role assignments for principals in a specific Fabric domain. +It sends a POST request to the relevant API endpoint. + +## EXAMPLES + +### EXAMPLE 1 + +Assign the `Admins` role to the specified principals in the domain with ID "12345". + +```powershell +Assign-FabricDomainWorkspaceRoleAssignment -DomainId "12345" -DomainRole "Admins" -PrincipalIds @(@{id="user1"; type="User"}, @{id="group1"; type="Group"}) +``` + +## PARAMETERS + +### -DomainId + +The unique identifier of the Fabric domain where roles will be assigned. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainRole + +The role to assign to the principals. +Must be one of the following: +- `Admins` +- `Contributors` + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PrincipalIds + +An array of principals to assign roles to. +Each principal must include: +- `id`: The identifier of the principal. +- `type`: The type of the principal (e.g., `User`, `Group`). + +```yaml +Type: System.Array +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Add-FabricWorkspaceCapacityAssignment.md b/docs/en-US/Add-FabricWorkspaceCapacityAssignment.md new file mode 100644 index 00000000..511fc4d3 --- /dev/null +++ b/docs/en-US/Add-FabricWorkspaceCapacityAssignment.md @@ -0,0 +1,110 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Add-FabricWorkspaceCapacityAssignment +--- + +# Add-FabricWorkspaceCapacityAssignment + +## SYNOPSIS + +Assigns a Fabric workspace to a specified capacity. + +## SYNTAX + +### __AllParameterSets + +``` +Add-FabricWorkspaceCapacityAssignment [-WorkspaceId] [-CapacityId] + [] +``` + +## ALIASES + +Assign-FabricWorkspaceCapacity + +## DESCRIPTION + +The `Add-FabricWorkspaceCapacityAssignment` function sends a POST request to assign a workspace to a specific capacity. + +## EXAMPLES + +### EXAMPLE 1 + +Assigns the workspace with ID "workspace123" to the capacity "capacity456". + +```powershell +Add-FabricWorkspaceCapacityAssignment -WorkspaceId "workspace123" -CapacityId "capacity456" +``` + +## PARAMETERS + +### -CapacityId + +The unique identifier of the capacity to which the workspace should be assigned. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace to be assigned. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Add-FabricWorkspaceIdentity.md b/docs/en-US/Add-FabricWorkspaceIdentity.md new file mode 100644 index 00000000..fb2443cd --- /dev/null +++ b/docs/en-US/Add-FabricWorkspaceIdentity.md @@ -0,0 +1,86 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Add-FabricWorkspaceIdentity +--- + +# Add-FabricWorkspaceIdentity + +## SYNOPSIS + +Provisions an identity for a Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Add-FabricWorkspaceIdentity [-WorkspaceId] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Add-FabricWorkspaceIdentity` function provisions an identity for a specified workspace by making an API call. + +## EXAMPLES + +### EXAMPLE 1 + +Provisions a Managed Identity for the workspace with ID "workspace123". + +```powershell +Add-FabricWorkspaceIdentity -WorkspaceId "workspace123" +``` + +## PARAMETERS + +### -WorkspaceId + +The unique identifier of the workspace for which the identity will be provisioned. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Add-FabricWorkspaceRoleAssignment.md b/docs/en-US/Add-FabricWorkspaceRoleAssignment.md new file mode 100644 index 00000000..f9e8aab6 --- /dev/null +++ b/docs/en-US/Add-FabricWorkspaceRoleAssignment.md @@ -0,0 +1,156 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Add-FabricWorkspaceRoleAssignment +--- + +# Add-FabricWorkspaceRoleAssignment + +## SYNOPSIS + +Assigns a role to a principal for a specified Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Add-FabricWorkspaceRoleAssignment [-WorkspaceId] [-PrincipalId] + [-PrincipalType] [-WorkspaceRole] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Add-FabricWorkspaceRoleAssignments` function assigns a role (e.g., Admin, Contributor, Member, Viewer) to a principal (e.g., User, Group, ServicePrincipal) in a Fabric workspace by making a POST request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Assigns the Admin role to the user with ID "principal123" in the workspace "workspace123". + +```powershell +Add-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -PrincipalId "principal123" -PrincipalType "User" -WorkspaceRole "Admin" +``` + +## PARAMETERS + +### -PrincipalId + +The unique identifier of the principal (User, Group, etc.) to assign the role. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PrincipalType + +The type of the principal. +Allowed values: Group, ServicePrincipal, ServicePrincipalProfile, User. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceRole + +The role to assign to the principal. +Allowed values: Admin, Contributor, Member, Viewer. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Collections.Hashtable + +{{ Fill in the Description }} + +## 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 }} + diff --git a/docs/en-US/Add-FabricWorkspaceToStage.md b/docs/en-US/Add-FabricWorkspaceToStage.md new file mode 100644 index 00000000..2cf99b82 --- /dev/null +++ b/docs/en-US/Add-FabricWorkspaceToStage.md @@ -0,0 +1,140 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Add-FabricWorkspaceToStage +--- + +# Add-FabricWorkspaceToStage + +## SYNOPSIS + +Assigns a workspace to a deployment pipeline stage. + +## SYNTAX + +### __AllParameterSets + +``` +Add-FabricWorkspaceToStage [-DeploymentPipelineId] [-StageId] [-WorkspaceId] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Add-FabricWorkspaceToStage` function assigns the specified workspace to the specified deployment pipeline stage. +This operation will fail if there's an active deployment operation. + +## EXAMPLES + +### EXAMPLE 1 + +Assigns the specified workspace to the deployment pipeline stage. + +```powershell +Add-FabricWorkspaceToStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" -WorkspaceId "GUID-GUID-GUID-GUID" +``` + +## PARAMETERS + +### -DeploymentPipelineId + +Required. +The ID of the deployment pipeline. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -StageId + +Required. +The ID of the deployment pipeline stage. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +Required. +The ID of the workspace to assign to the stage. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Requires Pipeline.ReadWrite.All and Workspace.ReadWrite.All delegated scopes. +- Requires admin deployment pipelines role and admin workspace role. +- This operation will fail if: + * There's an active deployment operation + * The specified stage is already assigned to another workspace + * The specified workspace is already assigned to another stage + * The caller is not a workspace admin +- This API is in preview. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Connect-FabricAccount.md b/docs/en-US/Connect-FabricAccount.md new file mode 100644 index 00000000..d21a11c7 --- /dev/null +++ b/docs/en-US/Connect-FabricAccount.md @@ -0,0 +1,243 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Connect-FabricAccount +--- + +# Connect-FabricAccount + +## SYNOPSIS + +Connects to the Fabric WebAPI. + +## SYNTAX + +### __AllParameterSets + +``` +Connect-FabricAccount [[-TenantId] ] [[-ServicePrincipalId] ] + [[-ServicePrincipalSecret] ] [[-Credential] ] [-Reset] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +Connects to the Fabric WebAPI by using the cmdlet Connect-AzAccount. +This function retrieves the authentication token for the Fabric API and sets up the headers for API calls. + +## EXAMPLES + +### EXAMPLE 1 + +Connects to the stated Tenant with existing credentials + +```powershell +Connect-FabricAccount -TenantId '12345678-1234-1234-1234-123456789012' +``` + +### EXAMPLE 2 + +Prompts for Service Principal id and secret and connects as that Service Principal + +```powershell +$credential = Get-Credential +Connect-FabricAccount -TenantId 'xxx' -credential $credential +``` + +### EXAMPLE 3 + +Connects as Service Principal using id and secret + +```powershell +Connect-FabricAccount -TenantId 'xxx' -ServicePrincipalId 'appId' -ServicePrincipalSecret $secret +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Credential + +A PSCredential object representing a user credential (username and secure password). + +```yaml +Type: System.Management.Automation.PSCredential +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Reset + +A switch parameter. +If provided, the function resets the Fabric authentication token. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ServicePrincipalId + +The Client ID (AppId) of the service principal used for authentication. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: +- AppId +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ServicePrincipalSecret + +The **secure string** representing the service principal secret. + +```yaml +Type: System.Security.SecureString +DefaultValue: '' +SupportsWildcards: false +Aliases: +- AppSecret +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TenantId + +The TenantId of the Azure Active Directory tenant you want to connect to and in which your Fabric Capacity is. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### None. This function does not return any output. + +{{ Fill in the Description }} + +## NOTES + +Revision History: + +- 2024-12-22 - FGE: Added Verbose Output +- 2025-05-26 - Jojobit: Added Service Principal support, with secure string handling and parameter descriptions, as supported by the original FabTools module +- 2025-06-02 - KNO: Added Reset switch to force re-authentication and token refresh + +Author: Frank Geisler, Kamil Nowinski + +## RELATED LINKS + +- [Connect-AzAccount https://learn.microsoft.com/de-de/powershell/module/az.accounts/connect-azaccount?view=azps-12.4.0]() diff --git a/documentation/Convert-FromBase64.md b/docs/en-US/Convert-FromBase64.md similarity index 52% rename from documentation/Convert-FromBase64.md rename to docs/en-US/Convert-FromBase64.md index bcdf8c42..f8cdef38 100644 --- a/documentation/Convert-FromBase64.md +++ b/docs/en-US/Convert-FromBase64.md @@ -1,22 +1,32 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Convert-FromBase64 --- # Convert-FromBase64 ## SYNOPSIS + Decodes a Base64-encoded string into its original text representation. ## SYNTAX +### __AllParameterSets + ``` -Convert-FromBase64 [-Base64String] [-ProgressAction ] [] +Convert-FromBase64 [-Base64String] [] ``` +## ALIASES + ## DESCRIPTION + The Convert-FromBase64 function takes a Base64-encoded string as input, decodes it into a byte array, and converts it back into a UTF-8 encoded string. It is useful for reversing Base64 encoding applied @@ -25,65 +35,64 @@ to text or other data. ## EXAMPLES ### EXAMPLE 1 -``` + +Output: Hello, World! + +```powershell Convert-FromBase64 -Base64String "SGVsbG8sIFdvcmxkIQ==" ``` -Output: -Hello, World! - ### EXAMPLE 2 -``` + +Output: Some encoded text + +```powershell $encodedString = "U29tZSBlbmNvZGVkIHRleHQ=" Convert-FromBase64 -Base64String $encodedString ``` -Output: -Some encoded text - ## PARAMETERS ### -Base64String + The Base64-encoded string that you want to decode. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +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, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES + This function assumes the Base64 input is a valid UTF-8 encoded string. Any decoding errors will throw a descriptive error message. Author: Tiago Balabuch ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Convert-ToBase64.md b/docs/en-US/Convert-ToBase64.md similarity index 53% rename from documentation/Convert-ToBase64.md rename to docs/en-US/Convert-ToBase64.md index 05dc22b9..840d7bb6 100644 --- a/documentation/Convert-ToBase64.md +++ b/docs/en-US/Convert-ToBase64.md @@ -1,22 +1,32 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Convert-ToBase64 --- # Convert-ToBase64 ## SYNOPSIS + Encodes the content of a file into a Base64-encoded string. ## SYNTAX +### __AllParameterSets + ``` -Convert-ToBase64 [-filePath] [-ProgressAction ] [] +Convert-ToBase64 [-filePath] [] ``` +## ALIASES + ## DESCRIPTION + The Convert-ToBase64 function takes a file path as input, reads the file's content as a byte array, and converts it into a Base64-encoded string. This is useful for embedding binary data (e.g., images, @@ -25,65 +35,69 @@ documents) in text-based formats such as JSON or XML. ## EXAMPLES ### EXAMPLE 1 -``` + +Output: VGhpcyBpcyBhbiBlbmNvZGVkIGZpbGUu + +```powershell Convert-ToBase64 -filePath "C:\Path\To\File.txt" ``` -Output: -VGhpcyBpcyBhbiBlbmNvZGVkIGZpbGUu - ### EXAMPLE 2 -``` -$encodedContent = Convert-ToBase64 -filePath "C:\Path\To\Image.jpg" -$encodedContent | Set-Content -Path "C:\Path\To\EncodedImage.txt" -``` This saves the Base64-encoded content of the image to a text file. +```powershell +$encodedContent = Convert-ToBase64 -filePath "C:\Path\To\Image.jpg + +$encodedContent | Set-Content -Path "C:\Path\To\EncodedImage.txt" This saves the Base64-encoded content of the image to a text file. +``` + ## PARAMETERS ### -filePath + The full path to the file whose contents you want to encode into Base64. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +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, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ### System.String + +{{ Fill in the Description }} + ## NOTES + - Ensure the file exists at the specified path before running this function. - Large files may cause memory constraints due to full loading into memory. Author: Tiago Balabuch ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Export-FabricItem.md b/docs/en-US/Export-FabricItem.md new file mode 100644 index 00000000..c32d2348 --- /dev/null +++ b/docs/en-US/Export-FabricItem.md @@ -0,0 +1,167 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Export-FabricItem +--- + +# Export-FabricItem + +## SYNOPSIS + +Exports items from a Fabric workspace. Either all items in a workspace or a specific item. + +## SYNTAX + +### __AllParameterSets + +``` +Export-FabricItem [[-path] ] [[-WorkspaceId] ] [[-filter] ] + [[-itemID] ] [] +``` + +## ALIASES + +Export-FabItem + +## DESCRIPTION + +The Export-FabricItem function exports items from a Fabric workspace to a specified directory. +It can export items of type "Report", "SemanticModel", "SparkJobDefinitionV1" or "Notebook". +If a specific item ID is provided, only that item will be exported. +Otherwise, all items in the workspace will be exported. + +## EXAMPLES + +### EXAMPLE 1 + +This example exports all items from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory. + +```powershell +Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -path "C:\ExportedItems" +``` + +### EXAMPLE 2 + +This example exports the item with the specified ID from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory. + +```powershell +Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -itemID "98765432-4321-4321-4321-9876543210BA" -path "C:\ExportedItems" +``` + +## PARAMETERS + +### -filter + +A script block used to filter the items to be exported. +Only items that match the filter will be exported. +The default filter includes items of type "Report", "SemanticModel", "SparkJobDefinitionV1" or "Notebook". + +```yaml +Type: System.Management.Automation.ScriptBlock +DefaultValue: '{ $_.type -in @("Report", "SemanticModel", "Notebook", "SparkJobDefinitionV1") }' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -itemID + +The ID of the specific item to export. +If provided, only that item will be exported. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -path + +The path to the directory where the items will be exported. +The default value is '.\pbipOutput'. + +```yaml +Type: System.String +DefaultValue: .\pbipOutput +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The ID of the Fabric workspace. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Rui Romano + +This function is based on the Export-FabricItems function written by Rui Romano. +https://github.com/microsoft/Analysis-Services/tree/master/pbidevmode/fabricps-pbip + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/FabricTools.md b/docs/en-US/FabricTools.md new file mode 100644 index 00000000..01496dbb --- /dev/null +++ b/docs/en-US/FabricTools.md @@ -0,0 +1,878 @@ +--- +document type: module +Help Version: 1.0.0.0 +HelpInfoUri: https://www.github.com/dataplat/FabricTools +Locale: en-US +Module Guid: f2a0f9e6-fab6-41fc-9e1c-0c94ff38f794 +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: FabricTools Module +--- + +# FabricTools Module + +## Description + +A module to be able to do more with Microsoft Fabric. + It lets you pause and resume Fabric capacities. + Adds functionality previously only available with the REST API as PowerShell functions. + There are also functions to make it easier to monitor usage metrics and refreshes. + It also adds Fabric-friendly aliases for PowerBI functions to make it easier to use the module. + +## FabricTools + +### [Add-FabricDomainWorkspaceAssignmentByCapacity](Add-FabricDomainWorkspaceAssignmentByCapacity.md) + +Assigns workspaces to a Fabric domain based on specified capacities. + +### [Add-FabricDomainWorkspaceAssignmentById](Add-FabricDomainWorkspaceAssignmentById.md) + +Assigns workspaces to a specified domain in Microsoft Fabric by their IDs. + +### [Add-FabricDomainWorkspaceAssignmentByPrincipal](Add-FabricDomainWorkspaceAssignmentByPrincipal.md) + +Assigns workspaces to a domain based on principal IDs in Microsoft Fabric. + +### [Add-FabricDomainWorkspaceRoleAssignment](Add-FabricDomainWorkspaceRoleAssignment.md) + +Bulk assigns roles to principals for workspaces in a Fabric domain. + +### [Add-FabricWorkspaceCapacityAssignment](Add-FabricWorkspaceCapacityAssignment.md) + +Assigns a Fabric workspace to a specified capacity. + +### [Add-FabricWorkspaceIdentity](Add-FabricWorkspaceIdentity.md) + +Provisions an identity for a Fabric workspace. + +### [Add-FabricWorkspaceRoleAssignment](Add-FabricWorkspaceRoleAssignment.md) + +Assigns a role to a principal for a specified Fabric workspace. + +### [Add-FabricWorkspaceToStage](Add-FabricWorkspaceToStage.md) + +Assigns a workspace to a deployment pipeline stage. + +### [Connect-FabricAccount](Connect-FabricAccount.md) + +Connects to the Fabric WebAPI. + +### [Convert-FromBase64](Convert-FromBase64.md) + +Decodes a Base64-encoded string into its original text representation. + +### [Convert-ToBase64](Convert-ToBase64.md) + +Encodes the content of a file into a Base64-encoded string. + +### [Export-FabricItem](Export-FabricItem.md) + +Exports items from a Fabric workspace. Either all items in a workspace or a specific item. + +### [Get-FabricAPIclusterURI](Get-FabricAPIclusterURI.md) + +Retrieves the cluster URI for the tenant. + +### [Get-FabricAuthToken](Get-FabricAuthToken.md) + +Retrieves the Fabric API authentication token. + +### [Get-FabricCapacities](Get-FabricCapacities.md) + +This function retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided. + +### [Get-FabricCapacity](Get-FabricCapacity.md) + +Retrieves capacity details from a specified Microsoft Fabric workspace. + +### [Get-FabricCapacityRefreshables](Get-FabricCapacityRefreshables.md) + +Retrieves the top refreshable capacities for the tenant. + +### [Get-FabricCapacitySkus](Get-FabricCapacitySkus.md) + +Retrieves the fabric capacity information. + +### [Get-FabricCapacityState](Get-FabricCapacityState.md) + +Retrieves the state of a specific capacity. + +### [Get-FabricCapacityTenantOverrides](Get-FabricCapacityTenantOverrides.md) + +Retrieves the tenant overrides for all capacities. + +### [Get-FabricCapacityTenantSettingOverrides](Get-FabricCapacityTenantSettingOverrides.md) + +Retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant. + +### [Get-FabricCapacityWorkload](Get-FabricCapacityWorkload.md) + +Retrieves the workloads for a specific capacity. + +### [Get-FabricConfig](Get-FabricConfig.md) + +Gets the configuration for use with all functions in the PSFabricTools module. + +### [Get-FabricConnection](Get-FabricConnection.md) + +Retrieves Fabric connections. + +### [Get-FabricCopyJob](Get-FabricCopyJob.md) + +Retrieves CopyJob details from a specified Microsoft Fabric workspace. + +### [Get-FabricCopyJobDefinition](Get-FabricCopyJobDefinition.md) + +Retrieves the definition of a Copy Job from a specific workspace in Microsoft Fabric. + +### [Get-FabricDashboard](Get-FabricDashboard.md) + +Retrieves dashboards from a specified workspace. + +### [Get-FabricDatamart](Get-FabricDatamart.md) + +Retrieves datamarts from a specified workspace. + +### [Get-FabricDataPipeline](Get-FabricDataPipeline.md) + +Retrieves data pipelines from a specified Microsoft Fabric workspace. + +### [Get-FabricDatasetRefreshes](Get-FabricDatasetRefreshes.md) + +Retrieves the refresh history of a specified dataset in a PowerBI workspace. + +### [Get-FabricDebugInfo](Get-FabricDebugInfo.md) + +Shows internal debug information about the current Azure & Fabric sessions & Fabric config. + +### [Get-FabricDeploymentPipeline](Get-FabricDeploymentPipeline.md) + +Retrieves deployment pipeline(s) from Microsoft Fabric. + +### [Get-FabricDeploymentPipelineOperation](Get-FabricDeploymentPipelineOperation.md) + +Retrieves details of a specific deployment pipeline operation. + +### [Get-FabricDeploymentPipelineRoleAssignments](Get-FabricDeploymentPipelineRoleAssignments.md) + +Returns a list of deployment pipeline role assignments. + +### [Get-FabricDeploymentPipelineStage](Get-FabricDeploymentPipelineStage.md) + +Retrieves details of deployment pipeline stages. + +### [Get-FabricDeploymentPipelineStageItem](Get-FabricDeploymentPipelineStageItem.md) + +Retrieves the supported items from the workspace assigned to a specific stage of a deployment pipeline. + +### [Get-FabricDomain](Get-FabricDomain.md) + +Retrieves domain information from Microsoft Fabric, optionally filtering by domain ID, domain name, or only non-empty domains. + +### [Get-FabricDomainTenantSettingOverrides](Get-FabricDomainTenantSettingOverrides.md) + +Retrieves tenant setting overrides for a specific domain or all capacities in the Fabric tenant. + +### [Get-FabricDomainWorkspace](Get-FabricDomainWorkspace.md) + +Retrieves the workspaces associated with a specific domain in Microsoft Fabric. + +### [Get-FabricEnvironment](Get-FabricEnvironment.md) + +Retrieves an environment or a list of environments from a specified workspace in Microsoft Fabric. + +### [Get-FabricEnvironmentLibrary](Get-FabricEnvironmentLibrary.md) + +Retrieves the list of libraries associated with a specific environment in a Microsoft Fabric workspace. + +### [Get-FabricEnvironmentSparkCompute](Get-FabricEnvironmentSparkCompute.md) + +Retrieves the Spark compute details for a specific environment in a Microsoft Fabric workspace. + +### [Get-FabricEnvironmentStagingLibrary](Get-FabricEnvironmentStagingLibrary.md) + +Retrieves the staging library details for a specific environment in a Microsoft Fabric workspace. + +### [Get-FabricEnvironmentStagingSparkCompute](Get-FabricEnvironmentStagingSparkCompute.md) + +Retrieves staging Spark compute details for a specific environment in a Microsoft Fabric workspace. + +### [Get-FabricEventhouse](Get-FabricEventhouse.md) + +Retrieves Fabric Eventhouses + +### [Get-FabricEventhouseDefinition](Get-FabricEventhouseDefinition.md) + +Retrieves the definition of an Eventhouse from a specified Microsoft Fabric workspace. + +### [Get-FabricEventstream](Get-FabricEventstream.md) + +Retrieves an Eventstream or a list of Eventstreams from a specified workspace in Microsoft Fabric. + +### [Get-FabricEventstreamDefinition](Get-FabricEventstreamDefinition.md) + +Retrieves the definition of a Eventstream from a specific workspace in Microsoft Fabric. + +### [Get-FabricExternalDataShares](Get-FabricExternalDataShares.md) + +Retrieves External Data Shares details from a specified Microsoft Fabric. + +### [Get-FabricItem](Get-FabricItem.md) + +Retrieves fabric items from a workspace. + +### [Get-FabricKQLDashboard](Get-FabricKQLDashboard.md) + +Retrieves an KQLDashboard or a list of KQLDashboards from a specified workspace in Microsoft Fabric. + +### [Get-FabricKQLDashboardDefinition](Get-FabricKQLDashboardDefinition.md) + +Retrieves the definition of a KQLDashboard from a specific workspace in Microsoft Fabric. + +### [Get-FabricKQLDatabase](Get-FabricKQLDatabase.md) + +Retrieves an KQLDatabase or a list of KQLDatabases from a specified workspace in Microsoft Fabric. + +### [Get-FabricKQLDatabaseDefinition](Get-FabricKQLDatabaseDefinition.md) + +Retrieves the definition of a KQLDatabase from a specific workspace in Microsoft Fabric. + +### [Get-FabricKQLQueryset](Get-FabricKQLQueryset.md) + +Retrieves an KQLQueryset or a list of KQLQuerysets from a specified workspace in Microsoft Fabric. + +### [Get-FabricKQLQuerysetDefinition](Get-FabricKQLQuerysetDefinition.md) + +Retrieves the definition of a KQLQueryset from a specific workspace in Microsoft Fabric. + +### [Get-FabricLakehouse](Get-FabricLakehouse.md) + +Retrieves an Lakehouse or a list of Lakehouses from a specified workspace in Microsoft Fabric. + +### [Get-FabricLakehouseTable](Get-FabricLakehouseTable.md) + +Retrieves tables from a specified Lakehouse in a Fabric workspace. + +### [Get-FabricLongRunningOperation](Get-FabricLongRunningOperation.md) + +Monitors the status of a long-running operation in Microsoft Fabric. + +### [Get-FabricLongRunningOperationResult](Get-FabricLongRunningOperationResult.md) + +Retrieves the result of a completed long-running operation from the Microsoft Fabric API. + +### [Get-FabricMirroredDatabase](Get-FabricMirroredDatabase.md) + +Retrieves an MirroredDatabase or a list of MirroredDatabases from a specified workspace in Microsoft Fabric. + +### [Get-FabricMirroredDatabaseDefinition](Get-FabricMirroredDatabaseDefinition.md) + +Retrieves the definition of a MirroredDatabase from a specific workspace in Microsoft Fabric. + +### [Get-FabricMirroredDatabaseStatus](Get-FabricMirroredDatabaseStatus.md) + +Retrieves the status of a mirrored database in a specified workspace. + +### [Get-FabricMirroredDatabaseTableStatus](Get-FabricMirroredDatabaseTableStatus.md) + +Retrieves the status of tables in a mirrored database. + +### [Get-FabricMirroredWarehouse](Get-FabricMirroredWarehouse.md) + +Retrieves an MirroredWarehouse or a list of MirroredWarehouses from a specified workspace in Microsoft Fabric. + +### [Get-FabricMLExperiment](Get-FabricMLExperiment.md) + +Retrieves ML Experiment details from a specified Microsoft Fabric workspace. + +### [Get-FabricMLModel](Get-FabricMLModel.md) + +Retrieves ML Model details from a specified Microsoft Fabric workspace. + +### [Get-FabricNotebook](Get-FabricNotebook.md) + +Retrieves an Notebook or a list of Notebooks from a specified workspace in Microsoft Fabric. + +### [Get-FabricNotebookDefinition](Get-FabricNotebookDefinition.md) + +Retrieves the definition of a notebook from a specific workspace in Microsoft Fabric. + +### [Get-FabricPaginatedReport](Get-FabricPaginatedReport.md) + +Retrieves paginated report details from a specified Microsoft Fabric workspace. + +### [Get-FabricRecoveryPoint](Get-FabricRecoveryPoint.md) + +Get a list of Fabric recovery points. + +### [Get-FabricReflex](Get-FabricReflex.md) + +Retrieves Reflex details from a specified Microsoft Fabric workspace. + +### [Get-FabricReflexDefinition](Get-FabricReflexDefinition.md) + +Retrieves the definition of an Reflex from a specified Microsoft Fabric workspace. + +### [Get-FabricReport](Get-FabricReport.md) + +Retrieves Report details from a specified Microsoft Fabric workspace. + +### [Get-FabricReportDefinition](Get-FabricReportDefinition.md) + +Retrieves the definition of an Report from a specified Microsoft Fabric workspace. + +### [Get-FabricSemanticModel](Get-FabricSemanticModel.md) + +Retrieves SemanticModel details from a specified Microsoft Fabric workspace. + +### [Get-FabricSemanticModelDefinition](Get-FabricSemanticModelDefinition.md) + +Retrieves the definition of an SemanticModel from a specified Microsoft Fabric workspace. + +### [Get-FabricSparkCustomPool](Get-FabricSparkCustomPool.md) + +Retrieves Spark custom pools from a specified workspace. + +### [Get-FabricSparkJobDefinition](Get-FabricSparkJobDefinition.md) + +Retrieves Spark Job Definition details from a specified Microsoft Fabric workspace. + +### [Get-FabricSparkJobDefinitionDefinition](Get-FabricSparkJobDefinitionDefinition.md) + +Retrieves the definition of an SparkJobDefinition from a specified Microsoft Fabric workspace. + +### [Get-FabricSparkSettings](Get-FabricSparkSettings.md) + +Retrieves Spark settings from a specified Microsoft Fabric workspace. + +### [Get-FabricSQLDatabase](Get-FabricSQLDatabase.md) + +Retrieves Fabric SQL Database details. + +### [Get-FabricSQLEndpoint](Get-FabricSQLEndpoint.md) + +Retrieves SQL Endpoints from a specified workspace in Fabric. + +### [Get-FabricTenantSetting](Get-FabricTenantSetting.md) + +Retrieves tenant settings from the Fabric environment. + +### [Get-FabricUsageMetricsQuery](Get-FabricUsageMetricsQuery.md) + +Retrieves usage metrics for a specific dataset. + +### [Get-FabricUserListAccessEntities](Get-FabricUserListAccessEntities.md) + +Retrieves access entities for a specified user in Microsoft Fabric. + +### [Get-FabricWarehouse](Get-FabricWarehouse.md) + +Retrieves warehouse details from a specified Microsoft Fabric workspace. + +### [Get-FabricWorkspace](Get-FabricWorkspace.md) + +Retrieves details of a Microsoft Fabric workspace by its ID or name. + +### [Get-FabricWorkspaceDatasetRefreshes](Get-FabricWorkspaceDatasetRefreshes.md) + +Retrieves the refresh history of all datasets in a specified PowerBI workspace. + +### [Get-FabricWorkspaceRoleAssignment](Get-FabricWorkspaceRoleAssignment.md) + +Retrieves role assignments for a specified Fabric workspace. + +### [Get-FabricWorkspaceTenantSettingOverrides](Get-FabricWorkspaceTenantSettingOverrides.md) + +Retrieves tenant setting overrides for all workspaces in the Fabric tenant. + +### [Get-FabricWorkspaceUsageMetricsData](Get-FabricWorkspaceUsageMetricsData.md) + +Retrieves workspace usage metrics data. + +### [Get-FabricWorkspaceUser](Get-FabricWorkspaceUser.md) + +Retrieves the user(s) of a workspace. + +### [Get-Sha256](Get-Sha256.md) + +Calculates the SHA256 hash of a string. + +### [Import-FabricEnvironmentStagingLibrary](Import-FabricEnvironmentStagingLibrary.md) + +Uploads a library to the staging environment in a Microsoft Fabric workspace. + +### [Import-FabricItem](Import-FabricItem.md) + +Imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. + +### [Invoke-FabricAPIRequest_duplicate](Invoke-FabricAPIRequest_duplicate.md) + +Sends an HTTP request to a Fabric API endpoint and retrieves the response. +Takes care of: authentication, 429 throttling, Long-Running-Operation (LRO) response + +### [Invoke-FabricDatasetRefresh](Invoke-FabricDatasetRefresh.md) + +This function invokes a refresh of a PowerBI dataset + +### [Invoke-FabricKQLCommand](Invoke-FabricKQLCommand.md) + +Executes a KQL command in a Kusto Database. + +### [Invoke-FabricRestMethod](Invoke-FabricRestMethod.md) + +Sends an HTTP request to a Fabric API endpoint and retrieves the response. + +### [Invoke-FabricRestMethodExtended](Invoke-FabricRestMethodExtended.md) + +Sends an HTTP request to a Fabric API endpoint and retrieves the response. +Takes care of: authentication, 429 throttling, Long-Running-Operation (LRO) response + +### [New-FabricCopyJob](New-FabricCopyJob.md) + +Creates a new copy job in a specified Microsoft Fabric workspace. + +### [New-FabricDataPipeline](New-FabricDataPipeline.md) + +Creates a new DataPipeline in a specified Microsoft Fabric workspace. + +### [New-FabricDeploymentPipeline](New-FabricDeploymentPipeline.md) + +Creates a new deployment pipeline. + +### [New-FabricDomain](New-FabricDomain.md) + +Creates a new Fabric domain. + +### [New-FabricEnvironment](New-FabricEnvironment.md) + +Creates a new environment in a specified workspace. + +### [New-FabricEventhouse](New-FabricEventhouse.md) + +Creates a new Eventhouse in a specified Microsoft Fabric workspace. + +### [New-FabricEventstream](New-FabricEventstream.md) + +Creates a new Eventstream in a specified Microsoft Fabric workspace. + +### [New-FabricKQLDashboard](New-FabricKQLDashboard.md) + +Creates a new KQLDashboard in a specified Microsoft Fabric workspace. + +### [New-FabricKQLDatabase](New-FabricKQLDatabase.md) + +Creates a new KQLDatabase in a specified Microsoft Fabric workspace. + +### [New-FabricKQLQueryset](New-FabricKQLQueryset.md) + +Creates a new KQLQueryset in a specified Microsoft Fabric workspace. + +### [New-FabricLakehouse](New-FabricLakehouse.md) + +Creates a new Lakehouse in a specified Microsoft Fabric workspace. + +### [New-FabricMirroredDatabase](New-FabricMirroredDatabase.md) + +Creates a new MirroredDatabase in a specified Microsoft Fabric workspace. + +### [New-FabricMLExperiment](New-FabricMLExperiment.md) + +Creates a new ML Experiment in a specified Microsoft Fabric workspace. + +### [New-FabricMLModel](New-FabricMLModel.md) + +Creates a new ML Model in a specified Microsoft Fabric workspace. + +### [New-FabricNotebook](New-FabricNotebook.md) + +Creates a new notebook in a specified Microsoft Fabric workspace. + +### [New-FabricNotebookNEW](New-FabricNotebookNEW.md) + +Creates a new notebook in a specified Microsoft Fabric workspace. + +### [New-FabricRecoveryPoint](New-FabricRecoveryPoint.md) + +Create a recovery point for a Fabric data warehouse + +### [New-FabricReflex](New-FabricReflex.md) + +Creates a new Reflex in a specified Microsoft Fabric workspace. + +### [New-FabricReport](New-FabricReport.md) + +Creates a new Report in a specified Microsoft Fabric workspace. + +### [New-FabricSemanticModel](New-FabricSemanticModel.md) + +Creates a new SemanticModel in a specified Microsoft Fabric workspace. + +### [New-FabricSparkCustomPool](New-FabricSparkCustomPool.md) + +Creates a new Spark custom pool in a specified Microsoft Fabric workspace. + +### [New-FabricSparkJobDefinition](New-FabricSparkJobDefinition.md) + +Creates a new SparkJobDefinition in a specified Microsoft Fabric workspace. + +### [New-FabricSQLDatabase](New-FabricSQLDatabase.md) + +Creates a new SQL Database in a specified Microsoft Fabric workspace. + +### [New-FabricWarehouse](New-FabricWarehouse.md) + +Creates a new warehouse in a specified Microsoft Fabric workspace. + +### [New-FabricWorkspace](New-FabricWorkspace.md) + +Creates a new Fabric workspace with the specified display name. + +### [New-FabricWorkspaceUsageMetricsReport](New-FabricWorkspaceUsageMetricsReport.md) + +Retrieves the workspace usage metrics dataset ID. + +### [Publish-FabricEnvironment](Publish-FabricEnvironment.md) + +Publishes a staging environment in a specified Microsoft Fabric workspace. + +### [Register-FabricWorkspaceToCapacity](Register-FabricWorkspaceToCapacity.md) + +Sets a PowerBI workspace to a capacity. + +### [Remove-FabricCopyJob](Remove-FabricCopyJob.md) + +Deletes a Copy Job from a specified Microsoft Fabric workspace. + +### [Remove-FabricDataPipeline](Remove-FabricDataPipeline.md) + +Removes a DataPipeline from a specified Microsoft Fabric workspace. + +### [Remove-FabricDeploymentPipeline](Remove-FabricDeploymentPipeline.md) + +Deletes a specified deployment pipeline. + +### [Remove-FabricDomain](Remove-FabricDomain.md) + +Deletes a Fabric domain by its ID. + +### [Remove-FabricDomainWorkspaceAssignment](Remove-FabricDomainWorkspaceAssignment.md) + +Unassign workspaces from a specified Fabric domain. + +### [Remove-FabricDomainWorkspaceRoleAssignment](Remove-FabricDomainWorkspaceRoleAssignment.md) + +Bulk unassign roles to principals for workspaces in a Fabric domain. + +### [Remove-FabricEnvironment](Remove-FabricEnvironment.md) + +Deletes an environment from a specified workspace in Microsoft Fabric. + +### [Remove-FabricEnvironmentStagingLibrary](Remove-FabricEnvironmentStagingLibrary.md) + +Deletes a specified library from the staging environment in a Microsoft Fabric workspace. + +### [Remove-FabricEventhouse](Remove-FabricEventhouse.md) + +Removes an Eventhouse from a specified Microsoft Fabric workspace. + +### [Remove-FabricEventstream](Remove-FabricEventstream.md) + +Deletes an Eventstream from a specified workspace in Microsoft Fabric. + +### [Remove-FabricItem](Remove-FabricItem.md) + +Removes selected items from a Fabric workspace. + +### [Remove-FabricKQLDashboard](Remove-FabricKQLDashboard.md) + +Deletes an KQLDashboard from a specified workspace in Microsoft Fabric. + +### [Remove-FabricKQLDatabase](Remove-FabricKQLDatabase.md) + +Deletes an KQLDatabase from a specified workspace in Microsoft Fabric. + +### [Remove-FabricKQLQueryset](Remove-FabricKQLQueryset.md) + +Deletes an KQLQueryset from a specified workspace in Microsoft Fabric. + +### [Remove-FabricLakehouse](Remove-FabricLakehouse.md) + +Deletes an Lakehouse from a specified workspace in Microsoft Fabric. + +### [Remove-FabricMirroredDatabase](Remove-FabricMirroredDatabase.md) + +Deletes an MirroredDatabase from a specified workspace in Microsoft Fabric. + +### [Remove-FabricMLExperiment](Remove-FabricMLExperiment.md) + +Removes an ML Experiment from a specified Microsoft Fabric workspace. + +### [Remove-FabricMLModel](Remove-FabricMLModel.md) + +Removes an ML Model from a specified Microsoft Fabric workspace. + +### [Remove-FabricNotebook](Remove-FabricNotebook.md) + +Deletes an Notebook from a specified workspace in Microsoft Fabric. + +### [Remove-FabricRecoveryPoint](Remove-FabricRecoveryPoint.md) + +Remove a selected Fabric Recovery Point. + +### [Remove-FabricReflex](Remove-FabricReflex.md) + +Removes an Reflex from a specified Microsoft Fabric workspace. + +### [Remove-FabricReport](Remove-FabricReport.md) + +Removes an Report from a specified Microsoft Fabric workspace. + +### [Remove-FabricSemanticModel](Remove-FabricSemanticModel.md) + +Removes an SemanticModel from a specified Microsoft Fabric workspace. + +### [Remove-FabricSparkCustomPool](Remove-FabricSparkCustomPool.md) + +Removes a Spark custom pool from a specified Microsoft Fabric workspace. + +### [Remove-FabricSparkJobDefinition](Remove-FabricSparkJobDefinition.md) + +Removes an SparkJobDefinition from a specified Microsoft Fabric workspace. + +### [Remove-FabricSQLDatabase](Remove-FabricSQLDatabase.md) + +Deletes a SQL Database from a specified workspace in Microsoft Fabric. + +### [Remove-FabricWarehouse](Remove-FabricWarehouse.md) + +Removes a warehouse from a specified Microsoft Fabric workspace. + +### [Remove-FabricWorkspace](Remove-FabricWorkspace.md) + +Deletes an existing Fabric workspace by its workspace ID. + +### [Remove-FabricWorkspaceCapacityAssignment](Remove-FabricWorkspaceCapacityAssignment.md) + +Unassigns a Fabric workspace from its capacity. + +### [Remove-FabricWorkspaceFromStage](Remove-FabricWorkspaceFromStage.md) + +Removes a workspace from a deployment pipeline stage. + +### [Remove-FabricWorkspaceIdentity](Remove-FabricWorkspaceIdentity.md) + +Deprovisions the Managed Identity for a specified Fabric workspace. + +### [Remove-FabricWorkspaceRoleAssignment](Remove-FabricWorkspaceRoleAssignment.md) + +Removes a role assignment from a Fabric workspace. + +### [Restore-FabricRecoveryPoint](Restore-FabricRecoveryPoint.md) + +Restore a Fabric data warehouse to a specified restore pont. + +### [Resume-FabricCapacity](Resume-FabricCapacity.md) + +Resumes a capacity. + +### [Revoke-FabricCapacityTenantSettingOverrides](Revoke-FabricCapacityTenantSettingOverrides.md) + +Removes a tenant setting override from a specific capacity in the Fabric tenant. + +### [Revoke-FabricExternalDataShares](Revoke-FabricExternalDataShares.md) + +Retrieves External Data Shares details from a specified Microsoft Fabric. + +### [Set-FabricConfig](Set-FabricConfig.md) + +Register the configuration for use with all functions in the PSFabricTools module. + +### [Start-FabricDeploymentPipelineStage](Start-FabricDeploymentPipelineStage.md) + +Deploys items from one stage to another in a deployment pipeline. + +### [Start-FabricLakehouseTableMaintenance](Start-FabricLakehouseTableMaintenance.md) + +Initiates a table maintenance job for a specified Lakehouse in a Fabric workspace. + +### [Start-FabricMirroredDatabaseMirroring](Start-FabricMirroredDatabaseMirroring.md) + +Starts the mirroring of a specified mirrored database in a given workspace. + +### [Start-FabricSparkJobDefinitionOnDemand](Start-FabricSparkJobDefinitionOnDemand.md) + +Starts a Fabric Spark Job Definition on demand. + +### [Stop-FabricEnvironmentPublish](Stop-FabricEnvironmentPublish.md) + +Cancels the publish operation for a specified environment in Microsoft Fabric. + +### [Stop-FabricMirroredDatabaseMirroring](Stop-FabricMirroredDatabaseMirroring.md) + +Stops the mirroring of a specified mirrored database in a given workspace. + +### [Suspend-FabricCapacity](Suspend-FabricCapacity.md) + +Suspends a capacity. + +### [Unregister-FabricWorkspaceToCapacity](Unregister-FabricWorkspaceToCapacity.md) + +Unregisters a workspace from a capacity. + +### [Update-FabricCapacityTenantSettingOverrides](Update-FabricCapacityTenantSettingOverrides.md) + +Updates tenant setting overrides for a specified capacity ID. + +### [Update-FabricCopyJob](Update-FabricCopyJob.md) + +Updates an existing Copy Job in a specified Microsoft Fabric workspace. + +### [Update-FabricCopyJobDefinition](Update-FabricCopyJobDefinition.md) + +Updates the definition of a Copy Job in a Microsoft Fabric workspace. + +### [Update-FabricDataPipeline](Update-FabricDataPipeline.md) + +Updates an existing DataPipeline in a specified Microsoft Fabric workspace. + +### [Update-FabricDomain](Update-FabricDomain.md) + +Updates a Fabric domain by its ID. + +### [Update-FabricEnvironment](Update-FabricEnvironment.md) + +Updates the properties of a Fabric Environment. + +### [Update-FabricEnvironmentStagingSparkCompute](Update-FabricEnvironmentStagingSparkCompute.md) + +Updates the Spark compute configuration in the staging environment for a given workspace. + +### [Update-FabricEventhouse](Update-FabricEventhouse.md) + +Updates an existing Eventhouse in a specified Microsoft Fabric workspace. + +### [Update-FabricEventhouseDefinition](Update-FabricEventhouseDefinition.md) + +Updates the definition of an existing Eventhouse in a specified Microsoft Fabric workspace. + +### [Update-FabricEventstream](Update-FabricEventstream.md) + +Updates the properties of a Fabric Eventstream. + +### [Update-FabricEventstreamDefinition](Update-FabricEventstreamDefinition.md) + +Updates the definition of a Eventstream in a Microsoft Fabric workspace. + +### [Update-FabricKQLDashboard](Update-FabricKQLDashboard.md) + +Updates the properties of a Fabric KQLDashboard. + +### [Update-FabricKQLDashboardDefinition](Update-FabricKQLDashboardDefinition.md) + +Updates the definition of a KQLDashboard in a Microsoft Fabric workspace. + +### [Update-FabricKQLDatabase](Update-FabricKQLDatabase.md) + +Updates the properties of a Fabric KQLDatabase. + +### [Update-FabricKQLDatabaseDefinition](Update-FabricKQLDatabaseDefinition.md) + +Updates the definition of a KQLDatabase in a Microsoft Fabric workspace. + +### [Update-FabricKQLQueryset](Update-FabricKQLQueryset.md) + +Updates the properties of a Fabric KQLQueryset. + +### [Update-FabricKQLQuerysetDefinition](Update-FabricKQLQuerysetDefinition.md) + +Updates the definition of a KQLQueryset in a Microsoft Fabric workspace. + +### [Update-FabricLakehouse](Update-FabricLakehouse.md) + +Updates the properties of a Fabric Lakehouse. + +### [Update-FabricMirroredDatabase](Update-FabricMirroredDatabase.md) + +Updates the properties of a Fabric MirroredDatabase. + +### [Update-FabricMirroredDatabaseDefinition](Update-FabricMirroredDatabaseDefinition.md) + +Updates the definition of a MirroredDatabase in a Microsoft Fabric workspace. + +### [Update-FabricMLExperiment](Update-FabricMLExperiment.md) + +Updates an existing ML Experiment in a specified Microsoft Fabric workspace. + +### [Update-FabricMLModel](Update-FabricMLModel.md) + +Updates an existing ML Model in a specified Microsoft Fabric workspace. + +### [Update-FabricNotebook](Update-FabricNotebook.md) + +Updates the properties of a Fabric Notebook. + +### [Update-FabricNotebookDefinition](Update-FabricNotebookDefinition.md) + +Updates the definition of a notebook in a Microsoft Fabric workspace. + +### [Update-FabricPaginatedReport](Update-FabricPaginatedReport.md) + +Updates an existing paginated report in a specified Microsoft Fabric workspace. + +### [Update-FabricReflex](Update-FabricReflex.md) + +Updates an existing Reflex in a specified Microsoft Fabric workspace. + +### [Update-FabricReflexDefinition](Update-FabricReflexDefinition.md) + +Updates the definition of an existing Reflex in a specified Microsoft Fabric workspace. + +### [Update-FabricReport](Update-FabricReport.md) + +Updates an existing Report in a specified Microsoft Fabric workspace. + +### [Update-FabricReportDefinition](Update-FabricReportDefinition.md) + +Updates the definition of an existing Report in a specified Microsoft Fabric workspace. + +### [Update-FabricSemanticModel](Update-FabricSemanticModel.md) + +Updates an existing SemanticModel in a specified Microsoft Fabric workspace. + +### [Update-FabricSemanticModelDefinition](Update-FabricSemanticModelDefinition.md) + +Updates the definition of an existing SemanticModel in a specified Microsoft Fabric workspace. + +### [Update-FabricSparkCustomPool](Update-FabricSparkCustomPool.md) + +Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. + +### [Update-FabricSparkJobDefinition](Update-FabricSparkJobDefinition.md) + +Updates an existing SparkJobDefinition in a specified Microsoft Fabric workspace. + +### [Update-FabricSparkJobDefinitionDefinition](Update-FabricSparkJobDefinitionDefinition.md) + +Updates the definition of an existing SparkJobDefinition in a specified Microsoft Fabric workspace. + +### [Update-FabricSparkSettings](Update-FabricSparkSettings.md) + +Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. + +### [Update-FabricWarehouse](Update-FabricWarehouse.md) + +Updates an existing warehouse in a specified Microsoft Fabric workspace. + +### [Update-FabricWorkspace](Update-FabricWorkspace.md) + +Updates the properties of a Fabric workspace. + +### [Update-FabricWorkspaceRoleAssignment](Update-FabricWorkspaceRoleAssignment.md) + +Updates the role assignment for a specific principal in a Fabric workspace. + +### [Write-FabricLakehouseTableData](Write-FabricLakehouseTableData.md) + +Loads data into a specified table in a Lakehouse within a Fabric workspace. + diff --git a/documentation/Get-FabricAPIclusterURI.md b/docs/en-US/Get-FabricAPIclusterURI.md similarity index 56% rename from documentation/Get-FabricAPIclusterURI.md rename to docs/en-US/Get-FabricAPIclusterURI.md index 775b9d04..027a846e 100644 --- a/documentation/Get-FabricAPIclusterURI.md +++ b/docs/en-US/Get-FabricAPIclusterURI.md @@ -1,60 +1,64 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricAPIclusterURI --- # Get-FabricAPIclusterURI ## SYNOPSIS + Retrieves the cluster URI for the tenant. ## SYNTAX +### __AllParameterSets + ``` -Get-FabricAPIclusterURI [-ProgressAction ] [] +Get-FabricAPIclusterURI [] ``` +## ALIASES + +Get-FabAPIClusterURI + ## DESCRIPTION + The Get-FabricAPIclusterURI function retrieves the cluster URI for the tenant. It supports multiple aliases for flexibility. ## EXAMPLES ### EXAMPLE 1 -``` + Get-FabricAPIclusterURI -``` This example retrieves the cluster URI for the tenant. ## PARAMETERS -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ### System.String + +{{ Fill in the Description }} + ## NOTES + The function retrieves the PowerBI access token and makes a GET request to the PowerBI API to retrieve the datasets. It then extracts the '@odata.context' property from the response, splits it on the '/' character, and selects the third element. This element is used to construct the cluster URI, which is then returned by the function. @@ -62,3 +66,6 @@ This element is used to construct the cluster URI, which is then returned by the Author: Ioana Bouariu ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricAuthToken.md b/docs/en-US/Get-FabricAuthToken.md new file mode 100644 index 00000000..de755a67 --- /dev/null +++ b/docs/en-US/Get-FabricAuthToken.md @@ -0,0 +1,69 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricAuthToken +--- + +# Get-FabricAuthToken + +## SYNOPSIS + +Retrieves the Fabric API authentication token. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricAuthToken [] +``` + +## ALIASES + +## DESCRIPTION + +The Get-FabricAuthToken function retrieves the Fabric API authentication token. +If the token is not already set, the function fails. + +## EXAMPLES + +### EXAMPLE 1 + +Get-FabricAuthToken + +This command retrieves the Fabric API authentication token. + +## PARAMETERS + +### 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None. You cannot pipe inputs to this function. + +{{ Fill in the Description }} + +## OUTPUTS + +### String. This function returns the Fabric API authentication token. + +{{ Fill in the Description }} + +## NOTES + +Author: Rui Romano + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricCapacities.md b/docs/en-US/Get-FabricCapacities.md new file mode 100644 index 00000000..045cacb3 --- /dev/null +++ b/docs/en-US/Get-FabricCapacities.md @@ -0,0 +1,97 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCapacities +--- + +# Get-FabricCapacities + +## SYNOPSIS + +This function retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricCapacities [[-subscriptionID] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The Get-FabricCapacities function is used to retrieve all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided. +It uses the Az module to interact with Azure. + +## EXAMPLES + +### EXAMPLE 1 + +This command retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in the subscription with the ID "12345678-1234-1234-1234-123456789012". ```powershell ``` + +```powershell +Get-FabricCapacities -subscriptionID "12345678-1234-1234-1234-123456789012" +``` + +### EXAMPLE 2 + +This command retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in all subscriptions. ```powershell ``` + +```powershell +Get-FabricCapacities +``` + +## PARAMETERS + +### -subscriptionID + +An optional parameter that specifies the subscription ID. +If this parameter is not provided, the function will retrieve resources from all subscriptions. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Ioana Bouariu +Imported into FabricTools April 2025 +Alias: Get-AllFabCapacities + +Define aliases for the function for flexibility. + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricCapacity.md b/docs/en-US/Get-FabricCapacity.md new file mode 100644 index 00000000..1f04ba78 --- /dev/null +++ b/docs/en-US/Get-FabricCapacity.md @@ -0,0 +1,118 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCapacity +--- + +# Get-FabricCapacity + +## SYNOPSIS + +Retrieves capacity details from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricCapacity [[-capacityId] ] [[-capacityName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves capacity details from a specified workspace using either the provided capacityId or capacityName. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the capacity details for the capacity with ID "capacity-12345". + +```powershell +Get-FabricCapacity -capacityId "capacity-12345" +``` + +### EXAMPLE 2 + +This example retrieves the capacity details for the capacity named "MyCapacity". + +```powershell +Get-FabricCapacity -capacityName "MyCapacity" +``` + +## PARAMETERS + +### -capacityId + +The unique identifier of the capacity to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -capacityName + +The name of the capacity to retrieve. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/documentation/Get-FabricCapacityRefreshables.md b/docs/en-US/Get-FabricCapacityRefreshables.md similarity index 51% rename from documentation/Get-FabricCapacityRefreshables.md rename to docs/en-US/Get-FabricCapacityRefreshables.md index 3d4f48f7..a9959f6f 100644 --- a/documentation/Get-FabricCapacityRefreshables.md +++ b/docs/en-US/Get-FabricCapacityRefreshables.md @@ -1,78 +1,90 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCapacityRefreshables --- # Get-FabricCapacityRefreshables ## SYNOPSIS + Retrieves the top refreshable capacities for the tenant. ## SYNTAX +### __AllParameterSets + ``` -Get-FabricCapacityRefreshables [[-top] ] [-ProgressAction ] [] +Get-FabricCapacityRefreshables [[-top] ] [] ``` +## ALIASES + +Get-FabCapacityRefreshables + ## DESCRIPTION + The Get-FabricCapacityRefreshables function retrieves the top refreshable capacities for the tenant. It supports multiple aliases for flexibility. ## EXAMPLES ### EXAMPLE 1 -``` -Get-FabricCapacityRefreshables -top 5 -``` This example retrieves the top 5 refreshable capacities for the tenant. -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +```powershell +Get-FabricCapacityRefreshables -top 5 ``` +## PARAMETERS + ### -top + The number of top refreshable capacities to retrieve. This is a mandatory parameter. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: 5 -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: 5 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES + The function retrieves the PowerBI access token and makes a GET request to the PowerBI API to retrieve the top refreshable capacities. It then returns the 'value' property of the response, which contains the capacities. Author: Ioana Bouariu ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricCapacitySkus.md b/docs/en-US/Get-FabricCapacitySkus.md new file mode 100644 index 00000000..d24a62dd --- /dev/null +++ b/docs/en-US/Get-FabricCapacitySkus.md @@ -0,0 +1,127 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCapacitySkus +--- + +# Get-FabricCapacitySkus + +## SYNOPSIS + +Retrieves the fabric capacity information. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricCapacitySkus [-subscriptionID] [-ResourceGroupName] [-capacity] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function makes a GET request to the Fabric API to retrieve the tenant settings. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the fabric capacity information for the specified capacity. + +```powershell +Get-FabricCapacitySkus -capacity "exampleCapacity" +``` + +## PARAMETERS + +### -capacity + +Specifies the capacity to retrieve information for. +If not provided, all capacities will be retrieved. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ResourceGroupName + +Specifies the name of the resource group in which the Fabric capacity is located. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -subscriptionID + +Specifies the subscription ID for the Azure subscription. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricCapacityState.md b/docs/en-US/Get-FabricCapacityState.md new file mode 100644 index 00000000..5e04ef8a --- /dev/null +++ b/docs/en-US/Get-FabricCapacityState.md @@ -0,0 +1,140 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCapacityState +--- + +# Get-FabricCapacityState + +## SYNOPSIS + +Retrieves the state of a specific capacity. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricCapacityState [-subscriptionID] [-resourcegroup] [-capacity] + [] +``` + +## ALIASES + +Get-FabCapacityState + +## DESCRIPTION + +The Get-FabricCapacityState function retrieves the state of a specific capacity. +It supports multiple aliases for flexibility. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the state of a specific capacity given the subscription ID, resource group, and capacity. + +```powershell +Get-FabricCapacityState -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" +``` + +## PARAMETERS + +### -capacity + +The capacity. +This is a mandatory parameter. +This is a parameter found in Azure, not Fabric. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -resourcegroup + +The resource group. +This is a mandatory parameter. +This is a parameter found in Azure, not Fabric. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -subscriptionID + +The ID of the subscription. +This is a mandatory parameter. +This is a parameter found in Azure, not Fabric. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +The function checks if the Azure token is null. +If it is, it connects to the Azure account and retrieves the token. +It then defines the headers for the GET request and the URL for the GET request. +Finally, it makes the GET request and returns the response. + +Author: Ioana Bouariu + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Get-FabricCapacityTenantOverrides.md b/docs/en-US/Get-FabricCapacityTenantOverrides.md similarity index 70% rename from documentation/Get-FabricCapacityTenantOverrides.md rename to docs/en-US/Get-FabricCapacityTenantOverrides.md index bad26bd2..b96aa165 100644 --- a/documentation/Get-FabricCapacityTenantOverrides.md +++ b/docs/en-US/Get-FabricCapacityTenantOverrides.md @@ -1,34 +1,47 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCapacityTenantOverrides --- # Get-FabricCapacityTenantOverrides ## SYNOPSIS + Retrieves the tenant overrides for all capacities. ## SYNTAX +### __AllParameterSets + ``` Get-FabricCapacityTenantOverrides ``` +## ALIASES + +Get-FabCapacityTenantOverrides + ## DESCRIPTION + The Get-FabricCapacityTenantOverrides function retrieves the tenant overrides for all capacities. It supports multiple aliases for flexibility. ## EXAMPLES ### EXAMPLE 1 -``` -Get-FabricCapacityTenantOverrides -``` This example retrieves the tenant overrides for all capacities. +```powershell +Get-FabricCapacityTenantOverrides +``` + ## PARAMETERS ## INPUTS @@ -36,9 +49,13 @@ This example retrieves the tenant overrides for all capacities. ## OUTPUTS ## NOTES + The function retrieves the PowerBI access token and makes a GET request to the Fabric API to retrieve the tenant overrides for all capacities. It then returns the response of the GET request. Author: Ioana Bouariu ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricCapacityTenantSettingOverrides.md b/docs/en-US/Get-FabricCapacityTenantSettingOverrides.md new file mode 100644 index 00000000..eb3a819b --- /dev/null +++ b/docs/en-US/Get-FabricCapacityTenantSettingOverrides.md @@ -0,0 +1,97 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCapacityTenantSettingOverrides +--- + +# Get-FabricCapacityTenantSettingOverrides + +## SYNOPSIS + +Retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricCapacityTenantSettingOverrides [[-CapacityId] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricCapacityTenantSettingOverrides` function retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant by making a GET request to the appropriate API endpoint. +If a `capacityId` is provided, the function retrieves overrides for that specific capacity. +Otherwise, it retrieves overrides for all capacities. + +## EXAMPLES + +### EXAMPLE 1 + +Returns all capacities tenant setting overrides. + +```powershell +Get-FabricCapacityTenantSettingOverrides +``` + +### EXAMPLE 2 + +Returns tenant setting overrides for the capacity with ID "12345". + +```powershell +Get-FabricCapacityTenantSettingOverrides -capacityId "12345" +``` + +## PARAMETERS + +### -CapacityId + +The ID of the capacity for which tenant setting overrides should be retrieved. +If not provided, overrides for all capacities will be retrieved. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/documentation/Get-FabricCapacityWorkload.md b/docs/en-US/Get-FabricCapacityWorkload.md similarity index 52% rename from documentation/Get-FabricCapacityWorkload.md rename to docs/en-US/Get-FabricCapacityWorkload.md index 83325b46..7273880d 100644 --- a/documentation/Get-FabricCapacityWorkload.md +++ b/docs/en-US/Get-FabricCapacityWorkload.md @@ -1,78 +1,90 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCapacityWorkload --- # Get-FabricCapacityWorkload ## SYNOPSIS + Retrieves the workloads for a specific capacity. ## SYNTAX +### __AllParameterSets + ``` -Get-FabricCapacityWorkload [-CapacityId] [-ProgressAction ] [] +Get-FabricCapacityWorkload [-CapacityId] [] ``` +## ALIASES + +Get-FabCapacityWorkload + ## DESCRIPTION + The Get-FabricCapacityWorkload function retrieves the workloads for a specific capacity. It supports multiple aliases for flexibility. ## EXAMPLES ### EXAMPLE 1 -``` -Get-FabricCapacityWorkload -capacityID "your-capacity-id" -``` This example retrieves the workloads for a specific capacity given the capacity ID and authentication token. +```powershell +Get-FabricCapacityWorkload -capacityID "your-capacity-id" +``` + ## PARAMETERS ### -CapacityId + The ID of the capacity. This is a mandatory parameter. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +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, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES + The function retrieves the PowerBI access token and makes a GET request to the PowerBI API to retrieve the workloads for the specified capacity. It then returns the 'value' property of the response, which contains the workloads. Author: Ioana Bouariu ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricConfig.md b/docs/en-US/Get-FabricConfig.md new file mode 100644 index 00000000..b806297b --- /dev/null +++ b/docs/en-US/Get-FabricConfig.md @@ -0,0 +1,84 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricConfig +--- + +# Get-FabricConfig + +## SYNOPSIS + +Gets the configuration for use with all functions in the PSFabricTools module. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricConfig [[-ConfigName] ] +``` + +## ALIASES + +## DESCRIPTION + +Gets the configuration for use with all functions in the PSFabricTools module. + +## EXAMPLES + +### EXAMPLE 1 + +Gets all configuration values for the PSFabricTools module and outputs them. + +```powershell +Get-FabricConfig +``` + +### EXAMPLE 2 + +Gets the BaseUrl configuration value for the PSFabricTools module. + +```powershell +Get-FabricConfig -ConfigName BaseUrl +``` + +## PARAMETERS + +### -ConfigName + +The name of the configuration to be retrieved. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Jess Pomfret + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Get-FabricConnection.md b/docs/en-US/Get-FabricConnection.md similarity index 52% rename from documentation/Get-FabricConnection.md rename to docs/en-US/Get-FabricConnection.md index f851e5ba..d23e3569 100644 --- a/documentation/Get-FabricConnection.md +++ b/docs/en-US/Get-FabricConnection.md @@ -1,84 +1,91 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricConnection --- # Get-FabricConnection ## SYNOPSIS + Retrieves Fabric connections. ## SYNTAX +### __AllParameterSets + ``` -Get-FabricConnection [[-connectionId] ] [-ProgressAction ] [] +Get-FabricConnection [[-connectionId] ] [] ``` +## ALIASES + ## DESCRIPTION + The Get-FabricConnection function retrieves Fabric connections. It can retrieve all connections or the specified one only. ## EXAMPLES ### EXAMPLE 1 -``` + Get-FabricConnection -``` This example retrieves all connections from Fabric ### EXAMPLE 2 -``` + Get-FabricConnection -connectionId "12345" -``` This example retrieves specific connection from Fabric with ID "12345". ## PARAMETERS ### -connectionId + The ID of the connection to retrieve. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES + https://learn.microsoft.com/en-us/rest/api/fabric/core/connections/get-connection?tabs=HTTP https://learn.microsoft.com/en-us/rest/api/fabric/core/connections/list-connections?tabs=HTTP Author: Kamil Nowinski ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricCopyJob.md b/docs/en-US/Get-FabricCopyJob.md new file mode 100644 index 00000000..55f120e2 --- /dev/null +++ b/docs/en-US/Get-FabricCopyJob.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCopyJob +--- + +# Get-FabricCopyJob + +## SYNOPSIS + +Retrieves CopyJob details from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricCopyJob [-WorkspaceId] [[-CopyJobId] ] [[-CopyJob] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves CopyJob details from a specified workspace using either the provided CopyJobId or CopyJob. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the CopyJob details for the CopyJob with ID "CopyJob-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "CopyJob-67890" +``` + +### EXAMPLE 2 + +This example retrieves the CopyJob details for the CopyJob named "My CopyJob" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJob "My CopyJob" +``` + +## PARAMETERS + +### -CopyJob + +The name of the CopyJob to retrieve. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobId + +The unique identifier of the CopyJob to retrieve. +This parameter is optional. + +```yaml +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 CopyJob exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricCopyJobDefinition.md b/docs/en-US/Get-FabricCopyJobDefinition.md new file mode 100644 index 00000000..9ff12d69 --- /dev/null +++ b/docs/en-US/Get-FabricCopyJobDefinition.md @@ -0,0 +1,133 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricCopyJobDefinition +--- + +# Get-FabricCopyJobDefinition + +## SYNOPSIS + +Retrieves the definition of a Copy Job from a specific workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricCopyJobDefinition [-WorkspaceId] [-CopyJobId] [[-CopyJobFormat] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function fetches the Copy Job's content or metadata from a workspace. +It supports both synchronous and asynchronous operations, with detailed logging and error handling. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the definition of the Copy Job with ID `67890` from the workspace with ID `12345`. + +```powershell +Get-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" +``` + +## PARAMETERS + +### -CopyJobFormat + +(Optional) Specifies the format of the Copy Job definition. +For example, 'json' or 'xml'. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobId + +(Mandatory) The unique identifier of the Copy Job whose definition needs to be retrieved. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace from which the Copy Job definition is to be retrieved. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Handles long-running operations asynchronously. +- Logs detailed information for debugging purposes. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricDashboard.md b/docs/en-US/Get-FabricDashboard.md new file mode 100644 index 00000000..f895a11e --- /dev/null +++ b/docs/en-US/Get-FabricDashboard.md @@ -0,0 +1,88 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDashboard +--- + +# Get-FabricDashboard + +## SYNOPSIS + +Retrieves dashboards from a specified workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDashboard [-WorkspaceId] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves all dashboards from a specified workspace using the provided WorkspaceId. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves all dashboards from the workspace with ID "12345". + +```powershell +Get-FabricDashboard -WorkspaceId "12345" +``` + +## PARAMETERS + +### -WorkspaceId + +The ID of the workspace from which to retrieve dashboards. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricDataPipeline.md b/docs/en-US/Get-FabricDataPipeline.md new file mode 100644 index 00000000..e80db302 --- /dev/null +++ b/docs/en-US/Get-FabricDataPipeline.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDataPipeline +--- + +# Get-FabricDataPipeline + +## SYNOPSIS + +Retrieves data pipelines from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDataPipeline [-WorkspaceId] [[-DataPipelineId] ] + [[-DataPipelineName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves all data pipelines from a specified workspace using either the provided Data PipelineId or Data PipelineName. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the Data Pipeline details for the Data Pipeline with ID "Data Pipeline-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineId "Data Pipeline-67890" +``` + +### EXAMPLE 2 + +This example retrieves the Data Pipeline details for the Data Pipeline named "My Data Pipeline" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineName "My Data Pipeline" +``` + +## PARAMETERS + +### -DataPipelineId + +The unique identifier of the Data Pipeline to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataPipelineName + +The name of the Data Pipeline to retrieve. +This parameter is optional. + +```yaml +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 Data Pipeline exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricDatamart.md b/docs/en-US/Get-FabricDatamart.md new file mode 100644 index 00000000..a7158dd9 --- /dev/null +++ b/docs/en-US/Get-FabricDatamart.md @@ -0,0 +1,133 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDatamart +--- + +# Get-FabricDatamart + +## SYNOPSIS + +Retrieves datamarts from a specified workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDatamart [-WorkspaceId] [[-datamartId] ] [[-datamartName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves all datamarts from a specified workspace using the provided WorkspaceId. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves all datamarts from the workspace with ID "12345". + +```powershell +Get-FabricDatamart -WorkspaceId "12345" +``` + +## PARAMETERS + +### -datamartId + +The ID of the specific datamart to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -datamartName + +The name of the specific datamart to retrieve. +This parameter is optional. + +```yaml +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 ID of the workspace from which to retrieve datamarts. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/documentation/Get-FabricDatasetRefreshes.md b/docs/en-US/Get-FabricDatasetRefreshes.md similarity index 51% rename from documentation/Get-FabricDatasetRefreshes.md rename to docs/en-US/Get-FabricDatasetRefreshes.md index d711d350..81dc7e42 100644 --- a/documentation/Get-FabricDatasetRefreshes.md +++ b/docs/en-US/Get-FabricDatasetRefreshes.md @@ -1,23 +1,34 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDatasetRefreshes --- # Get-FabricDatasetRefreshes ## SYNOPSIS + Retrieves the refresh history of a specified dataset in a PowerBI workspace. ## SYNTAX +### __AllParameterSets + ``` -Get-FabricDatasetRefreshes [-DatasetID] [-workspaceId] [-ProgressAction ] - [] +Get-FabricDatasetRefreshes [-DatasetID] [-workspaceId] [] ``` +## ALIASES + +Get-FabDatasetRefreshes + ## DESCRIPTION + The Get-FabricDatasetRefreshes function uses the PowerBI cmdlets to retrieve the refresh history of a specified dataset in a workspace. It uses the dataset ID and workspace ID to get the dataset and checks if it is refreshable. If it is, the function retrieves the refresh history. @@ -25,73 +36,88 @@ If it is, the function retrieves the refresh history. ## EXAMPLES ### EXAMPLE 1 -``` -Get-FabricDatasetRefreshes -DatasetID "12345678-90ab-cdef-1234-567890abcdef" -workspaceId "abcdef12-3456-7890-abcd-ef1234567890" -``` This command retrieves the refresh history of the specified dataset in the specified workspace. +```powershell +Get-FabricDatasetRefreshes -DatasetID "12345678-90ab-cdef-1234-567890abcdef" -workspaceId "abcdef12-3456-7890-abcd-ef1234567890" +``` + ## PARAMETERS ### -DatasetID + The ID of the dataset. This is a mandatory parameter. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -workspaceId + The ID of the workspace. This is a mandatory parameter. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### String. You can pipe two strings that contain the dataset ID and workspace ID to Get-FabricDatasetRefreshes. + +{{ Fill in the Description }} + ## OUTPUTS ### Object. Get-FabricDatasetRefreshes returns an object that contains the refresh history. + +{{ Fill in the Description }} + ## NOTES + Alias: Get-PowerBIDatasetRefreshes, Get-FabDatasetRefreshes Author: Ioana Bouariu + +Define aliases for the function for flexibility. + ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Get-FabricDebugInfo.md b/docs/en-US/Get-FabricDebugInfo.md similarity index 52% rename from documentation/Get-FabricDebugInfo.md rename to docs/en-US/Get-FabricDebugInfo.md index 5275e7b9..6b10496d 100644 --- a/documentation/Get-FabricDebugInfo.md +++ b/docs/en-US/Get-FabricDebugInfo.md @@ -1,22 +1,32 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDebugInfo --- # Get-FabricDebugInfo ## SYNOPSIS + Shows internal debug information about the current Azure & Fabric sessions & Fabric config. ## SYNTAX +### __AllParameterSets + ``` -Get-FabricDebugInfo [-ProgressAction ] [] +Get-FabricDebugInfo [] ``` +## ALIASES + ## DESCRIPTION + Shows internal debug information about the current session. It is useful for troubleshooting purposes. It will show you the current session object. @@ -27,38 +37,33 @@ for connecting to the REST API directly via Postman. ## EXAMPLES ### EXAMPLE 1 -``` + Get-FabricDebugInfo -``` This example shows the current session object. ## PARAMETERS -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ### System.Collections.Hashtable + +{{ Fill in the Description }} + ## NOTES + Author: Frank Geisler, Kamil Nowinski ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricDeploymentPipeline.md b/docs/en-US/Get-FabricDeploymentPipeline.md new file mode 100644 index 00000000..28a2adc6 --- /dev/null +++ b/docs/en-US/Get-FabricDeploymentPipeline.md @@ -0,0 +1,126 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDeploymentPipeline +--- + +# Get-FabricDeploymentPipeline + +## SYNOPSIS + +Retrieves deployment pipeline(s) from Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDeploymentPipeline [[-DeploymentPipelineId] ] [[-DeploymentPipelineName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricDeploymentPipeline` function fetches deployment pipeline(s) from the Fabric API. +It can either retrieve all pipelines or a specific pipeline by ID. +It automatically handles pagination when retrieving all pipelines. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves all deployment pipelines that the user can access. + +```powershell +Get-FabricDeploymentPipeline +``` + +### EXAMPLE 2 + +Retrieves a specific deployment pipeline with detailed information including its stages. + +```powershell +Get-FabricDeploymentPipeline -DeploymentPipelineId "GUID-GUID-GUID-GUID" +``` + +## PARAMETERS + +### -DeploymentPipelineId + +Optional. +The ID of a specific deployment pipeline to retrieve. +If not provided, all pipelines will be retrieved. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DeploymentPipelineName + +Optional. +The display name of a specific deployment pipeline to retrieve. +If provided, it will filter the results to match this name. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: +- Name +- DisplayName +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Returns a collection of deployment pipelines with their IDs, display names, and descriptions. +- When retrieving a specific pipeline, returns extended information including stages. +- Requires Pipeline.Read.All or Pipeline.ReadWrite.All delegated scopes. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricDeploymentPipelineOperation.md b/docs/en-US/Get-FabricDeploymentPipelineOperation.md new file mode 100644 index 00000000..ab7d00a2 --- /dev/null +++ b/docs/en-US/Get-FabricDeploymentPipelineOperation.md @@ -0,0 +1,118 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDeploymentPipelineOperation +--- + +# Get-FabricDeploymentPipelineOperation + +## SYNOPSIS + +Retrieves details of a specific deployment pipeline operation. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDeploymentPipelineOperation [-DeploymentPipelineId] [-OperationId] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricDeploymentPipelineOperation` function fetches detailed information about a specific deployment operation +performed on a deployment pipeline, including the deployment execution plan, status, and timing information. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves details of a specific deployment operation, including its execution plan and status. + +```powershell +Get-FabricDeploymentPipelineOperation -DeploymentPipelineId "GUID-GUID-GUID-GUID" -OperationId "GUID-GUID-GUID-GUID" +``` + +## PARAMETERS + +### -DeploymentPipelineId + +Required. +The ID of the deployment pipeline. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -OperationId + +Required. +The ID of the operation to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Returns detailed operation information including: + - Operation status and type + - Execution timing + - Source and target stage information + - Deployment execution plan with steps + - Pre-deployment diff information + - Performed by information +- Requires Pipeline.Read.All or Pipeline.ReadWrite.All delegated scopes. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricDeploymentPipelineRoleAssignments.md b/docs/en-US/Get-FabricDeploymentPipelineRoleAssignments.md new file mode 100644 index 00000000..f9e29910 --- /dev/null +++ b/docs/en-US/Get-FabricDeploymentPipelineRoleAssignments.md @@ -0,0 +1,90 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDeploymentPipelineRoleAssignments +--- + +# Get-FabricDeploymentPipelineRoleAssignments + +## SYNOPSIS + +Returns a list of deployment pipeline role assignments. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDeploymentPipelineRoleAssignments [-DeploymentPipelineId] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricDeploymentPipelineRoleAssignments` function retrieves a list of role assignments for a deployment pipeline. +The function automatically handles pagination and returns all available role assignments. + +## EXAMPLES + +### EXAMPLE 1 + +Returns all role assignments for the specified deployment pipeline. + +```powershell +Get-FabricDeploymentPipelineRoleAssignments -DeploymentPipelineId "GUID-GUID-GUID-GUID" +``` + +## PARAMETERS + +### -DeploymentPipelineId + +Required. +The ID of the deployment pipeline to get role assignments for. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Requires Pipeline.Read.All or Pipeline.ReadWrite.All delegated scope. +- Requires admin deployment pipelines role. +- This API is in preview. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricDeploymentPipelineStage.md b/docs/en-US/Get-FabricDeploymentPipelineStage.md new file mode 100644 index 00000000..50aeea8c --- /dev/null +++ b/docs/en-US/Get-FabricDeploymentPipelineStage.md @@ -0,0 +1,128 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDeploymentPipelineStage +--- + +# Get-FabricDeploymentPipelineStage + +## SYNOPSIS + +Retrieves details of deployment pipeline stages. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDeploymentPipelineStage [-DeploymentPipelineId] [[-StageId] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricDeploymentPipelineStage` function fetches information about stages in a deployment pipeline. +When a StageId is provided, it returns details for that specific stage. +When no StageId is provided, +it returns a list of all stages in the pipeline. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves details of a specific deployment pipeline stage, including its workspace assignment and settings. + +```powershell +Get-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" +``` + +### EXAMPLE 2 + +Retrieves a list of all stages in the specified deployment pipeline. + +```powershell +Get-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" +``` + +## PARAMETERS + +### -DeploymentPipelineId + +Required. +The ID of the deployment pipeline. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -StageId + +Optional. +The ID of the specific stage to retrieve. +If not provided, returns all stages in the pipeline. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Returns detailed stage information including: + - Stage ID and display name + - Description + - Order in the pipeline + - Workspace assignment (if any) + - Public/private visibility setting +- Requires Pipeline.Read.All or Pipeline.ReadWrite.All delegated scopes. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricDeploymentPipelineStageItem.md b/docs/en-US/Get-FabricDeploymentPipelineStageItem.md new file mode 100644 index 00000000..cfeffd7e --- /dev/null +++ b/docs/en-US/Get-FabricDeploymentPipelineStageItem.md @@ -0,0 +1,120 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDeploymentPipelineStageItem +--- + +# Get-FabricDeploymentPipelineStageItem + +## SYNOPSIS + +Retrieves the supported items from the workspace assigned to a specific stage of a deployment pipeline. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDeploymentPipelineStageItem [-DeploymentPipelineId] [-StageId] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricDeploymentPipelineStageItem` function returns a list of supported items from the workspace +assigned to the specified stage of a deployment pipeline. +The function automatically handles pagination +and returns all available items. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves all items from the specified stage of the deployment pipeline. + +```powershell +Get-FabricDeploymentPipelineStageItem -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" +``` + +## PARAMETERS + +### -DeploymentPipelineId + +Required. +The ID of the deployment pipeline. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -StageId + +Required. +The ID of the stage to retrieve items from. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Requires Pipeline.Read.All or Pipeline.ReadWrite.All delegated scope. +- Requires admin deployment pipelines role. +- The user must be at least a workspace contributor assigned to the specified stage. +- Returns items with their metadata including: + - Item ID and display name + - Item type (Report, Dashboard, SemanticModel, etc.) + - Source and target item IDs (if applicable) + - Last deployment time (if applicable) + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricDomain.md b/docs/en-US/Get-FabricDomain.md new file mode 100644 index 00000000..bcd42c89 --- /dev/null +++ b/docs/en-US/Get-FabricDomain.md @@ -0,0 +1,142 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDomain +--- + +# Get-FabricDomain + +## SYNOPSIS + +Retrieves domain information from Microsoft Fabric, optionally filtering by domain ID, domain name, or only non-empty domains. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDomain [[-DomainId] ] [[-DomainName] ] [[-NonEmptyDomainsOnly] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricDomain` function allows retrieval of domains in Microsoft Fabric, with optional filtering by domain ID or name. +Additionally, it can filter to return only non-empty domains. + +## EXAMPLES + +### EXAMPLE 1 + +Fetches the domain with ID "12345". + +```powershell +Get-FabricDomain -DomainId "12345" +``` + +### EXAMPLE 2 + +Fetches the domain with the display name "Finance". + +```powershell +Get-FabricDomain -DomainName "Finance" +``` + +## PARAMETERS + +### -DomainId + +(Optional) The ID of the domain to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainName + +(Optional) The display name of the domain to retrieve. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NonEmptyDomainsOnly + +(Optional) If set to `$true`, only domains containing workspaces will be returned. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +{{ Fill in the Description }} + +## 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 }} + diff --git a/docs/en-US/Get-FabricDomainTenantSettingOverrides.md b/docs/en-US/Get-FabricDomainTenantSettingOverrides.md new file mode 100644 index 00000000..da59af66 --- /dev/null +++ b/docs/en-US/Get-FabricDomainTenantSettingOverrides.md @@ -0,0 +1,67 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDomainTenantSettingOverrides +--- + +# Get-FabricDomainTenantSettingOverrides + +## SYNOPSIS + +Retrieves tenant setting overrides for a specific domain or all capacities in the Fabric tenant. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDomainTenantSettingOverrides [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricDomainTenantSettingOverrides` function retrieves tenant setting overrides for all domains in the Fabric tenant by making a GET request to the designated API endpoint. +The function ensures token validity before making the request and handles the response appropriately. + +## EXAMPLES + +### EXAMPLE 1 + +Fetches tenant setting overrides for all domains in the Fabric tenant. + +```powershell +Get-FabricDomainTenantSettingOverrides +``` + +## PARAMETERS + +### 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires the `$FabricConfig` global configuration, which must include `BaseUrl` and `FabricHeaders`. +- Ensures token validity by invoking `Confirm-TokenState` before making the API request. +- Logs detailed messages for debugging and error handling. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricDomainWorkspace.md b/docs/en-US/Get-FabricDomainWorkspace.md new file mode 100644 index 00000000..e5810db7 --- /dev/null +++ b/docs/en-US/Get-FabricDomainWorkspace.md @@ -0,0 +1,86 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricDomainWorkspace +--- + +# Get-FabricDomainWorkspace + +## SYNOPSIS + +Retrieves the workspaces associated with a specific domain in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricDomainWorkspace [-DomainId] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricDomainWorkspace` function fetches the workspaces for the given domain ID. + +## EXAMPLES + +### EXAMPLE 1 + +Fetches workspaces for the domain with ID "12345". + +```powershell +Get-FabricDomainWorkspace -DomainId "12345" +``` + +## PARAMETERS + +### -DomainId + +The ID of the domain for which to retrieve workspaces. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricEnvironment.md b/docs/en-US/Get-FabricEnvironment.md new file mode 100644 index 00000000..916bb193 --- /dev/null +++ b/docs/en-US/Get-FabricEnvironment.md @@ -0,0 +1,139 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricEnvironment +--- + +# Get-FabricEnvironment + +## SYNOPSIS + +Retrieves an environment or a list of environments from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricEnvironment [-WorkspaceId] [[-EnvironmentId] ] [[-EnvironmentName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricEnvironment` function sends a GET request to the Fabric API to retrieve environment details for a given workspace. +It can filter the results by `EnvironmentName`. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the "Development" environment from workspace "12345". + +```powershell +Get-FabricEnvironment -WorkspaceId "12345" -EnvironmentName "Development" +``` + +### EXAMPLE 2 + +Retrieves all environments in workspace "12345". + +```powershell +Get-FabricEnvironment -WorkspaceId "12345" +``` + +## PARAMETERS + +### -EnvironmentId + +(Optional) The ID of a specific environment to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentName + +(Optional) The name of the specific environment to retrieve. + +```yaml +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 environments. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Returns the matching environment details or all environments if no filter is provided. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricEnvironmentLibrary.md b/docs/en-US/Get-FabricEnvironmentLibrary.md new file mode 100644 index 00000000..3c06c86d --- /dev/null +++ b/docs/en-US/Get-FabricEnvironmentLibrary.md @@ -0,0 +1,110 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricEnvironmentLibrary +--- + +# Get-FabricEnvironmentLibrary + +## SYNOPSIS + +Retrieves the list of libraries associated with a specific environment in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricEnvironmentLibrary [-WorkspaceId] [-EnvironmentId] [] +``` + +## ALIASES + +## DESCRIPTION + +The Get-FabricEnvironmentLibrary function fetches library information for a given workspace and environment +using the Microsoft Fabric API. +It ensures the authentication token is valid and validates the response +to handle errors gracefully. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the libraries associated with the specified environment in the given workspace. + +```powershell +Get-FabricEnvironmentLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" +``` + +## PARAMETERS + +### -EnvironmentId + +The unique identifier of the environment whose libraries are being queried. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace where the environment is located. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. +- Uses `Confirm-TokenState` to validate the token before making API calls. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricEnvironmentSparkCompute.md b/docs/en-US/Get-FabricEnvironmentSparkCompute.md new file mode 100644 index 00000000..b1ae723d --- /dev/null +++ b/docs/en-US/Get-FabricEnvironmentSparkCompute.md @@ -0,0 +1,110 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricEnvironmentSparkCompute +--- + +# Get-FabricEnvironmentSparkCompute + +## SYNOPSIS + +Retrieves the Spark compute details for a specific environment in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricEnvironmentSparkCompute [-WorkspaceId] [-EnvironmentId] [] +``` + +## ALIASES + +## DESCRIPTION + +The Get-FabricEnvironmentSparkCompute function communicates with the Microsoft Fabric API to fetch information +about Spark compute resources associated with a specified environment. +It ensures that the API token is valid +and gracefully handles errors during the API call. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves Spark compute details for the specified environment in the given workspace. + +```powershell +Get-FabricEnvironmentSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" +``` + +## PARAMETERS + +### -EnvironmentId + +The unique identifier of the environment whose Spark compute details are being retrieved. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace containing the target environment. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. +- Uses `Confirm-TokenState` to validate the token before making API calls. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricEnvironmentStagingLibrary.md b/docs/en-US/Get-FabricEnvironmentStagingLibrary.md new file mode 100644 index 00000000..afb6926e --- /dev/null +++ b/docs/en-US/Get-FabricEnvironmentStagingLibrary.md @@ -0,0 +1,110 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricEnvironmentStagingLibrary +--- + +# Get-FabricEnvironmentStagingLibrary + +## SYNOPSIS + +Retrieves the staging library details for a specific environment in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricEnvironmentStagingLibrary [-WorkspaceId] [-EnvironmentId] + [] +``` + +## ALIASES + +## DESCRIPTION + +The Get-FabricEnvironmentStagingLibrary function interacts with the Microsoft Fabric API to fetch information +about staging libraries associated with a specified environment. +It ensures token validity and handles API errors gracefully. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the staging libraries for the specified environment in the given workspace. + +```powershell +Get-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" +``` + +## PARAMETERS + +### -EnvironmentId + +The unique identifier of the environment for which staging library details are being retrieved. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace containing the target environment. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. +- Uses `Confirm-TokenState` to validate the token before making API calls. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricEnvironmentStagingSparkCompute.md b/docs/en-US/Get-FabricEnvironmentStagingSparkCompute.md new file mode 100644 index 00000000..89405062 --- /dev/null +++ b/docs/en-US/Get-FabricEnvironmentStagingSparkCompute.md @@ -0,0 +1,110 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricEnvironmentStagingSparkCompute +--- + +# Get-FabricEnvironmentStagingSparkCompute + +## SYNOPSIS + +Retrieves staging Spark compute details for a specific environment in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricEnvironmentStagingSparkCompute [-WorkspaceId] [-EnvironmentId] + [] +``` + +## ALIASES + +## DESCRIPTION + +The Get-FabricEnvironmentStagingSparkCompute function interacts with the Microsoft Fabric API to fetch information +about staging Spark compute configurations for a specified environment. +It ensures token validity and handles API errors gracefully. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the staging Spark compute configurations for the specified environment in the given workspace. + +```powershell +Get-FabricEnvironmentStagingSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" +``` + +## PARAMETERS + +### -EnvironmentId + +The unique identifier of the environment for which staging Spark compute details are being retrieved. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace containing the target environment. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. +- Uses `Confirm-TokenState` to validate the token before making API calls. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricEventhouse.md b/docs/en-US/Get-FabricEventhouse.md new file mode 100644 index 00000000..1568f4ae --- /dev/null +++ b/docs/en-US/Get-FabricEventhouse.md @@ -0,0 +1,171 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricEventhouse +--- + +# Get-FabricEventhouse + +## SYNOPSIS + +Retrieves Fabric Eventhouses + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricEventhouse [-WorkspaceId] [[-EventhouseId] ] [[-EventhouseName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +Retrieves Fabric Eventhouses. +Without the EventhouseName or EventhouseID parameter, all Eventhouses are returned. +If you want to retrieve a specific Eventhouse, you can use the EventhouseName or EventhouseID parameter. +These +parameters cannot be used together. + +## EXAMPLES + +### EXAMPLE 1 + +This example will give you all Eventhouses in the Workspace. + +```powershell +Get-FabricEventhouse ` +-WorkspaceId '12345678-1234-1234-1234-123456789012' +``` + +### EXAMPLE 2 + +This example will give you all Information about the Eventhouse with the name 'MyEventhouse'. + +```powershell +Get-FabricEventhouse ` +-WorkspaceId '12345678-1234-1234-1234-123456789012' ` +-EventhouseName 'MyEventhouse' +``` + +### EXAMPLE 3 + +This example will give you all Information about the Eventhouse with the Id '12345678-1234-1234-1234-123456789012'. + +```powershell +Get-FabricEventhouse ` +-WorkspaceId '12345678-1234-1234-1234-123456789012' ` +-EventhouseId '12345678-1234-1234-1234-123456789012' +``` + +### EXAMPLE 4 + +This example will give you all Information about the Eventhouse with the Id '12345678-1234-1234-1234-123456789012'. It will also give you verbose output which is useful for debugging. + +```powershell +Get-FabricEventhouse ` +-WorkspaceId '12345678-1234-1234-1234-123456789012' ` +-EventhouseId '12345678-1234-1234-1234-123456789012' ` +-Verbose +``` + +## PARAMETERS + +### -EventhouseId + +The Id of the Eventhouse to retrieve. +This parameter cannot be used together with EventhouseName. +The value for WorkspaceId is a GUID. +An example of a GUID is '12345678-1234-1234-1234-123456789012'. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhouseName + +The name of the Eventhouse to retrieve. +This parameter cannot be used together with EventhouseID. + +```yaml +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 + +Id of the Fabric Workspace for which the Eventhouses should be retrieved. +The value for WorkspaceId is a GUID. +An example of a GUID is '12345678-1234-1234-1234-123456789012'. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +TODO: Add functionality to list all Eventhouses in the subscription. +To do so fetch all workspaces +and then all eventhouses in each workspace. + +Author: Tiago Balabuch + +## RELATED LINKS + +- [](https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP) diff --git a/docs/en-US/Get-FabricEventhouseDefinition.md b/docs/en-US/Get-FabricEventhouseDefinition.md new file mode 100644 index 00000000..c4b5e0dc --- /dev/null +++ b/docs/en-US/Get-FabricEventhouseDefinition.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricEventhouseDefinition +--- + +# Get-FabricEventhouseDefinition + +## SYNOPSIS + +Retrieves the definition of an Eventhouse from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricEventhouseDefinition [-WorkspaceId] [[-EventhouseId] ] + [[-EventhouseFormat] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves the definition of an Eventhouse from a specified workspace using the provided EventhouseId. +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 Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" +``` + +### EXAMPLE 2 + +This example retrieves the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" in JSON format. + +```powershell +Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhouseFormat "json" +``` + +## PARAMETERS + +### -EventhouseFormat + +The format in which to retrieve the Eventhouse definition. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhouseId + +The unique identifier of the Eventhouse to retrieve the definition for. +This parameter is optional. + +```yaml +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 Eventhouse exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricEventstream.md b/docs/en-US/Get-FabricEventstream.md new file mode 100644 index 00000000..555ebbec --- /dev/null +++ b/docs/en-US/Get-FabricEventstream.md @@ -0,0 +1,144 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricEventstream +--- + +# Get-FabricEventstream + +## SYNOPSIS + +Retrieves an Eventstream or a list of Eventstreams from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricEventstream [-WorkspaceId] [[-EventstreamId] ] [[-EventstreamName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +Retrieves Fabric Eventstreams. +Without the EventstreamName or EventstreamID parameter, all Eventstreams are returned. +If you want to retrieve a specific Eventstream, you can use the EventstreamName or EventstreamID parameter. +These +parameters cannot be used together. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the "Development" Eventstream from workspace "12345". + +```powershell +Get-FabricEventstream -WorkspaceId "12345" -EventstreamName "Development" +``` + +### EXAMPLE 2 + +Retrieves all Eventstreams in workspace "12345". + +```powershell +Get-FabricEventstream -WorkspaceId "12345" +``` + +## PARAMETERS + +### -EventstreamId + +The Id of the Eventstream to retrieve. +This parameter cannot be used together with EventstreamName. +The value for EventstreamId is a GUID. +An example of a GUID is '12345678-1234-1234-1234-123456789012'. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamName + +(Optional) The name of the specific Eventstream to retrieve. + +```yaml +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 Eventstreams. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricEventstreamDefinition.md b/docs/en-US/Get-FabricEventstreamDefinition.md new file mode 100644 index 00000000..55efa5d6 --- /dev/null +++ b/docs/en-US/Get-FabricEventstreamDefinition.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricEventstreamDefinition +--- + +# Get-FabricEventstreamDefinition + +## SYNOPSIS + +Retrieves the definition of a Eventstream from a specific workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricEventstreamDefinition [-WorkspaceId] [[-EventstreamId] ] + [[-EventstreamFormat] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function fetches the Eventstream's content or metadata from a workspace. +Handles both synchronous and asynchronous operations, with detailed logging and error handling. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the definition of the Eventstream with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" +``` + +### EXAMPLE 2 + +Retrieves the definitions of all Eventstreams in the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricEventstreamDefinition -WorkspaceId "12345" +``` + +## PARAMETERS + +### -EventstreamFormat + +Specifies the format of the Eventstream definition. +Currently, only 'ipynb' is supported. +Default: 'ipynb'. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamId + +(Optional)The unique identifier of the Eventstream whose definition needs to be retrieved. + +```yaml +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 + +(Mandatory) The unique identifier of the workspace from which the Eventstream definition is to be retrieved. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Handles long-running operations asynchronously. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricExternalDataShares.md b/docs/en-US/Get-FabricExternalDataShares.md new file mode 100644 index 00000000..8f7d7c9d --- /dev/null +++ b/docs/en-US/Get-FabricExternalDataShares.md @@ -0,0 +1,66 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricExternalDataShares +--- + +# Get-FabricExternalDataShares + +## SYNOPSIS + +Retrieves External Data Shares details from a specified Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricExternalDataShares [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves External Data Shares details. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the External Data Shares details + +```powershell +Get-FabricExternalDataShares +``` + +## PARAMETERS + +### 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricItem.md b/docs/en-US/Get-FabricItem.md new file mode 100644 index 00000000..09f704ad --- /dev/null +++ b/docs/en-US/Get-FabricItem.md @@ -0,0 +1,161 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricItem +--- + +# Get-FabricItem + +## SYNOPSIS + +Retrieves fabric items from a workspace. + +## SYNTAX + +### WorkspaceId + +``` +Get-FabricItem -WorkspaceId [-type ] [-itemID ] [] +``` + +### WorkspaceObject + +``` +Get-FabricItem -Workspace [-type ] [-itemID ] [] +``` + +## ALIASES + +## DESCRIPTION + +The Get-FabricItem function retrieves fabric items from a specified workspace. +It can retrieve all items or filter them by item type. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves all fabric items of type "file" from the workspace with ID "12345". + +```powershell +Get-FabricItem -workspaceId "12345" -type "file" +``` + +## PARAMETERS + +### -itemID + +The ID of the specific item to retrieve. +If not specified, all items will be retrieved. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -type + +(Optional) The type of the fabric items to retrieve. +If not specified, all items will be retrieved. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: +- itemType +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Workspace + +The workspace object from which to retrieve the fabric items. +This parameter can be piped into the function. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceObject + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The ID of the workspace from which to retrieve the fabric items. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceId + Position: Named + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +{{ Fill in the Description }} + +## OUTPUTS + +## NOTES + +Author: Rui Romano + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricKQLDashboard.md b/docs/en-US/Get-FabricKQLDashboard.md new file mode 100644 index 00000000..21b89d82 --- /dev/null +++ b/docs/en-US/Get-FabricKQLDashboard.md @@ -0,0 +1,138 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricKQLDashboard +--- + +# Get-FabricKQLDashboard + +## SYNOPSIS + +Retrieves an KQLDashboard or a list of KQLDashboards from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricKQLDashboard [-WorkspaceId] [[-KQLDashboardId] ] + [[-KQLDashboardName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricKQLDashboard` function sends a GET request to the Fabric API to retrieve KQLDashboard details for a given workspace. +It can filter the results by `KQLDashboardName`. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the "Development" KQLDashboard from workspace "12345". .PARAMETER KQLDashboardID The Id of the KQLDashboard to retrieve. This parameter cannot be used together with KQLDashboardName. The value for KQLDashboardID is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'. + +```powershell +Get-FabricKQLDashboard -WorkspaceId "12345" -KQLDashboardName "Development" +``` + +### EXAMPLE 2 + +Retrieves all KQLDashboards in workspace "12345". + +```powershell +Get-FabricKQLDashboard -WorkspaceId "12345" +``` + +## PARAMETERS + +### -KQLDashboardId + +(Optional) The ID of the specific KQLDashboard to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardName + +(Optional) The name of the specific KQLDashboard to retrieve. + +```yaml +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 KQLDashboards. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricKQLDashboardDefinition.md b/docs/en-US/Get-FabricKQLDashboardDefinition.md new file mode 100644 index 00000000..71ac47ba --- /dev/null +++ b/docs/en-US/Get-FabricKQLDashboardDefinition.md @@ -0,0 +1,139 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricKQLDashboardDefinition +--- + +# Get-FabricKQLDashboardDefinition + +## SYNOPSIS + +Retrieves the definition of a KQLDashboard from a specific workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricKQLDashboardDefinition [-WorkspaceId] [[-KQLDashboardId] ] + [[-KQLDashboardFormat] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function fetches the KQLDashboard's content or metadata from a workspace. +Handles both synchronous and asynchronous operations, with detailed logging and error handling. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the definition of the KQLDashboard with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" +``` + +### EXAMPLE 2 + +Retrieves the definitions of all KQLDashboards in the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricKQLDashboardDefinition -WorkspaceId "12345" +``` + +## PARAMETERS + +### -KQLDashboardFormat + +Specifies the format of the KQLDashboard definition. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardId + +(Optional)The unique identifier of the KQLDashboard whose definition needs to be retrieved. + +```yaml +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 + +(Mandatory) The unique identifier of the workspace from which the KQLDashboard definition is to be retrieved. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Handles long-running operations asynchronously. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricKQLDatabase.md b/docs/en-US/Get-FabricKQLDatabase.md new file mode 100644 index 00000000..5666fc85 --- /dev/null +++ b/docs/en-US/Get-FabricKQLDatabase.md @@ -0,0 +1,138 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricKQLDatabase +--- + +# Get-FabricKQLDatabase + +## SYNOPSIS + +Retrieves an KQLDatabase or a list of KQLDatabases from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricKQLDatabase [-WorkspaceId] [[-KQLDatabaseId] ] [[-KQLDatabaseName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricKQLDatabase` function sends a GET request to the Fabric API to retrieve KQLDatabase details for a given workspace. +It can filter the results by `KQLDatabaseName`. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the "Development" KQLDatabase from workspace "12345". + +```powershell +Get-FabricKQLDatabase -WorkspaceId "12345" -KQLDatabaseName "Development" +``` + +### EXAMPLE 2 + +Retrieves all KQLDatabases in workspace "12345". + +```powershell +Get-FabricKQLDatabase -WorkspaceId "12345" +``` + +## PARAMETERS + +### -KQLDatabaseId + +(Optional) The ID of a specific KQLDatabase to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseName + +(Optional) The name of the specific KQLDatabase to retrieve. + +```yaml +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 KQLDatabases. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricKQLDatabaseDefinition.md b/docs/en-US/Get-FabricKQLDatabaseDefinition.md new file mode 100644 index 00000000..c62c73d9 --- /dev/null +++ b/docs/en-US/Get-FabricKQLDatabaseDefinition.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricKQLDatabaseDefinition +--- + +# Get-FabricKQLDatabaseDefinition + +## SYNOPSIS + +Retrieves the definition of a KQLDatabase from a specific workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricKQLDatabaseDefinition [-WorkspaceId] [[-KQLDatabaseId] ] + [[-KQLDatabaseFormat] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function fetches the KQLDatabase's content or metadata from a workspace. +It supports retrieving KQLDatabase definitions in the Jupyter KQLDatabase (`ipynb`) format. +Handles both synchronous and asynchronous operations, with detailed logging and error handling. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the definition of the KQLDatabase with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" +``` + +### EXAMPLE 2 + +Retrieves the definitions of all KQLDatabases in the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricKQLDatabaseDefinition -WorkspaceId "12345" +``` + +## PARAMETERS + +### -KQLDatabaseFormat + +Specifies the format of the KQLDatabase definition. +Currently, only 'ipynb' is supported. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseId + +(Optional)The unique identifier of the KQLDatabase whose definition needs to be retrieved. + +```yaml +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 + +(Mandatory) The unique identifier of the workspace from which the KQLDatabase definition is to be retrieved. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Handles long-running operations asynchronously. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricKQLQueryset.md b/docs/en-US/Get-FabricKQLQueryset.md new file mode 100644 index 00000000..b68f46ef --- /dev/null +++ b/docs/en-US/Get-FabricKQLQueryset.md @@ -0,0 +1,138 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricKQLQueryset +--- + +# Get-FabricKQLQueryset + +## SYNOPSIS + +Retrieves an KQLQueryset or a list of KQLQuerysets from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricKQLQueryset [-WorkspaceId] [[-KQLQuerysetId] ] [[-KQLQuerysetName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricKQLQueryset` function sends a GET request to the Fabric API to retrieve KQLQueryset details for a given workspace. +It can filter the results by `KQLQuerysetName`. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the "Development" KQLQueryset from workspace "12345". + +```powershell +Get-FabricKQLQueryset -WorkspaceId "12345" -KQLQuerysetName "Development" +``` + +### EXAMPLE 2 + +Retrieves all KQLQuerysets in workspace "12345". + +```powershell +Get-FabricKQLQueryset -WorkspaceId "12345" +``` + +## PARAMETERS + +### -KQLQuerysetId + +(Optional) The ID of a specific KQLQueryset to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetName + +(Optional) The name of the specific KQLQueryset to retrieve. + +```yaml +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 KQLQuerysets. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricKQLQuerysetDefinition.md b/docs/en-US/Get-FabricKQLQuerysetDefinition.md new file mode 100644 index 00000000..93ca1ea8 --- /dev/null +++ b/docs/en-US/Get-FabricKQLQuerysetDefinition.md @@ -0,0 +1,139 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricKQLQuerysetDefinition +--- + +# Get-FabricKQLQuerysetDefinition + +## SYNOPSIS + +Retrieves the definition of a KQLQueryset from a specific workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricKQLQuerysetDefinition [-WorkspaceId] [[-KQLQuerysetId] ] + [[-KQLQuerysetFormat] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function fetches the KQLQueryset's content or metadata from a workspace. +Handles both synchronous and asynchronous operations, with detailed logging and error handling. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the definition of the KQLQueryset with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" +``` + +### EXAMPLE 2 + +Retrieves the definitions of all KQLQuerysets in the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricKQLQuerysetDefinition -WorkspaceId "12345" +``` + +## PARAMETERS + +### -KQLQuerysetFormat + +Specifies the format of the KQLQueryset definition. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetId + +(Optional)The unique identifier of the KQLQueryset whose definition needs to be retrieved. + +```yaml +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 + +(Mandatory) The unique identifier of the workspace from which the KQLQueryset definition is to be retrieved. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Handles long-running operations asynchronously. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricLakehouse.md b/docs/en-US/Get-FabricLakehouse.md new file mode 100644 index 00000000..c4dfe49e --- /dev/null +++ b/docs/en-US/Get-FabricLakehouse.md @@ -0,0 +1,138 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricLakehouse +--- + +# Get-FabricLakehouse + +## SYNOPSIS + +Retrieves an Lakehouse or a list of Lakehouses from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricLakehouse [-WorkspaceId] [[-LakehouseId] ] [[-LakehouseName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricLakehouse` function sends a GET request to the Fabric API to retrieve Lakehouse details for a given workspace. +It can filter the results by `LakehouseName`. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the "Development" Lakehouse from workspace "12345". + +```powershell +Get-FabricLakehouse -WorkspaceId "12345" -LakehouseName "Development" +``` + +### EXAMPLE 2 + +Retrieves all Lakehouses in workspace "12345". + +```powershell +Get-FabricLakehouse -WorkspaceId "12345" +``` + +## PARAMETERS + +### -LakehouseId + +(Optional) The ID of a specific Lakehouse to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseName + +(Optional) The name of the specific Lakehouse to retrieve. + +```yaml +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 Lakehouses. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricLakehouseTable.md b/docs/en-US/Get-FabricLakehouseTable.md new file mode 100644 index 00000000..dd6693e1 --- /dev/null +++ b/docs/en-US/Get-FabricLakehouseTable.md @@ -0,0 +1,109 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricLakehouseTable +--- + +# Get-FabricLakehouseTable + +## SYNOPSIS + +Retrieves tables from a specified Lakehouse in a Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricLakehouseTable [-WorkspaceId] [[-LakehouseId] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves tables from a specified Lakehouse in a Fabric workspace. +It handles pagination using a continuation token to ensure all data is retrieved. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves all tables from the specified Lakehouse in the specified workspace. + +```powershell +Get-FabricLakehouseTable -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" +``` + +## PARAMETERS + +### -LakehouseId + +The ID of the Lakehouse from which to retrieve tables. + +```yaml +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 ID of the workspace containing the Lakehouse. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +{{ Fill in the Description }} + +## NOTES + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricLongRunningOperation.md b/docs/en-US/Get-FabricLongRunningOperation.md new file mode 100644 index 00000000..84b1f9be --- /dev/null +++ b/docs/en-US/Get-FabricLongRunningOperation.md @@ -0,0 +1,130 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricLongRunningOperation +--- + +# Get-FabricLongRunningOperation + +## SYNOPSIS + +Monitors the status of a long-running operation in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricLongRunningOperation [[-OperationId] ] [[-Location] ] + [[-RetryAfter] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The Get-FabricLongRunningOperation function queries the Microsoft Fabric API to check the status of a +long-running operation. +It periodically polls the operation until it reaches a terminal state (Succeeded or Failed). + +## EXAMPLES + +### EXAMPLE 1 + +This command polls the status of the operation with the given operationId every 10 seconds until it completes. ```powershell ``` + +```powershell +Get-FabricLongRunningOperation -operationId "12345-abcd-67890-efgh" -retryAfter 10 +``` + +## PARAMETERS + +### -Location + +The URL provided in the Location header of the initial request. +This is used to check the status of the operation. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -OperationId + +The unique identifier of the long-running operation to be monitored. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -RetryAfter + +The interval (in seconds) to wait between polling the operation status. +The default is 5 seconds. + +```yaml +Type: System.Int32 +DefaultValue: 5 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricLongRunningOperationResult.md b/docs/en-US/Get-FabricLongRunningOperationResult.md new file mode 100644 index 00000000..e7f9a6a5 --- /dev/null +++ b/docs/en-US/Get-FabricLongRunningOperationResult.md @@ -0,0 +1,89 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricLongRunningOperationResult +--- + +# Get-FabricLongRunningOperationResult + +## SYNOPSIS + +Retrieves the result of a completed long-running operation from the Microsoft Fabric API. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricLongRunningOperationResult [-OperationId] [] +``` + +## ALIASES + +## DESCRIPTION + +The Get-FabricLongRunningOperationResult function queries the Microsoft Fabric API to fetch the result +of a specific long-running operation. +This is typically used after confirming the operation has completed successfully. + +## EXAMPLES + +### EXAMPLE 1 + +This command fetches the result of the operation with the specified operationId. ```powershell ``` + +```powershell +Get-FabricLongRunningOperationResult -operationId "12345-abcd-67890-efgh" +``` + +## PARAMETERS + +### -OperationId + +The unique identifier of the completed long-running operation whose result you want to retrieve. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Ensure the Fabric API headers (e.g., authorization tokens) are defined in $FabricConfig.FabricHeaders. +- This function does not handle polling. +Ensure the operation is in a terminal state before calling this function. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricMLExperiment.md b/docs/en-US/Get-FabricMLExperiment.md new file mode 100644 index 00000000..9e8dec7d --- /dev/null +++ b/docs/en-US/Get-FabricMLExperiment.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricMLExperiment +--- + +# Get-FabricMLExperiment + +## SYNOPSIS + +Retrieves ML Experiment details from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricMLExperiment [-WorkspaceId] [[-MLExperimentId] ] + [[-MLExperimentName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves ML Experiment details from a specified workspace using either the provided MLExperimentId or MLExperimentName. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the ML Experiment details for the experiment with ID "experiment-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" +``` + +### EXAMPLE 2 + +This example retrieves the ML Experiment details for the experiment named "My ML Experiment" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentName "My ML Experiment" +``` + +## PARAMETERS + +### -MLExperimentId + +The unique identifier of the ML Experiment to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLExperimentName + +The name of the ML Experiment to retrieve. +This parameter is optional. + +```yaml +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 Experiment exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricMLModel.md b/docs/en-US/Get-FabricMLModel.md new file mode 100644 index 00000000..fa35e603 --- /dev/null +++ b/docs/en-US/Get-FabricMLModel.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +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] [[-MLModelId] ] [[-MLModelName] ] + [] +``` + +## 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". + +```powershell +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". + +```powershell +Get-FabricMLModel -WorkspaceId "workspace-12345" -MLModelName "My ML Model" +``` + +## PARAMETERS + +### -MLModelId + +The unique identifier of the ML Model to retrieve. +This parameter is optional. + +```yaml +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. + +```yaml +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. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricMirroredDatabase.md b/docs/en-US/Get-FabricMirroredDatabase.md new file mode 100644 index 00000000..3e6cae3c --- /dev/null +++ b/docs/en-US/Get-FabricMirroredDatabase.md @@ -0,0 +1,138 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricMirroredDatabase +--- + +# Get-FabricMirroredDatabase + +## SYNOPSIS + +Retrieves an MirroredDatabase or a list of MirroredDatabases from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricMirroredDatabase [-WorkspaceId] [[-MirroredDatabaseId] ] + [[-MirroredDatabaseName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricMirroredDatabase` function sends a GET request to the Fabric API to retrieve MirroredDatabase details for a given workspace. +It can filter the results by `MirroredDatabaseName`. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the "Development" MirroredDatabase from workspace "12345". + +```powershell +Get-FabricMirroredDatabase -WorkspaceId "12345" -MirroredDatabaseName "Development" +``` + +### EXAMPLE 2 + +Retrieves all MirroredDatabases in workspace "12345". + +```powershell +Get-FabricMirroredDatabase -WorkspaceId "12345" +``` + +## PARAMETERS + +### -MirroredDatabaseId + +(Optional) The ID of a specific MirroredDatabase to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseName + +(Optional) The name of the specific MirroredDatabase to retrieve. + +```yaml +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 MirroredDatabases. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricMirroredDatabaseDefinition.md b/docs/en-US/Get-FabricMirroredDatabaseDefinition.md new file mode 100644 index 00000000..cdd4e2c0 --- /dev/null +++ b/docs/en-US/Get-FabricMirroredDatabaseDefinition.md @@ -0,0 +1,118 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricMirroredDatabaseDefinition +--- + +# Get-FabricMirroredDatabaseDefinition + +## SYNOPSIS + +Retrieves the definition of a MirroredDatabase from a specific workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricMirroredDatabaseDefinition [-WorkspaceId] [[-MirroredDatabaseId] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function fetches the MirroredDatabase's content or metadata from a workspace. +Handles both synchronous and asynchronous operations, with detailed logging and error handling. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the definition of the MirroredDatabase with ID `67890` from the workspace with ID `12345`. + +```powershell +Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" +``` + +### EXAMPLE 2 + +Retrieves the definitions of all MirroredDatabases in the workspace with ID `12345`. + +```powershell +Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345" +``` + +## PARAMETERS + +### -MirroredDatabaseId + +(Optional)The unique identifier of the MirroredDatabase whose definition needs to be retrieved. + +```yaml +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 + +(Mandatory) The unique identifier of the workspace from which the MirroredDatabase definition is to be retrieved. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Handles long-running operations asynchronously. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricMirroredDatabaseStatus.md b/docs/en-US/Get-FabricMirroredDatabaseStatus.md new file mode 100644 index 00000000..d9a4cd0c --- /dev/null +++ b/docs/en-US/Get-FabricMirroredDatabaseStatus.md @@ -0,0 +1,107 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricMirroredDatabaseStatus +--- + +# Get-FabricMirroredDatabaseStatus + +## SYNOPSIS + +Retrieves the status of a mirrored database in a specified workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricMirroredDatabaseStatus [-WorkspaceId] [[-MirroredDatabaseId] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +Retrieves the status of a mirrored database in a specified workspace. +The function validates the authentication token, constructs the API endpoint URL, and makes a POST request to retrieve the mirroring status. +It handles errors and logs messages at various levels (Debug, Error). + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the status of a mirrored database with the specified ID in the specified workspace. + +```powershell +Get-FabricMirroredDatabaseStatus -WorkspaceId "your-workspace-id" -MirroredDatabaseId "your-mirrored-database-id" +``` + +## PARAMETERS + +### -MirroredDatabaseId + +the ID of the mirrored database whose status is to be retrieved. + +```yaml +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 ID of the workspace containing the mirrored database. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Get-FabricMirroredDatabaseTableStatus.md b/docs/en-US/Get-FabricMirroredDatabaseTableStatus.md similarity index 52% rename from documentation/Get-FabricMirroredDatabaseTableStatus.md rename to docs/en-US/Get-FabricMirroredDatabaseTableStatus.md index cda2451d..c6292247 100644 --- a/documentation/Get-FabricMirroredDatabaseTableStatus.md +++ b/docs/en-US/Get-FabricMirroredDatabaseTableStatus.md @@ -1,23 +1,33 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricMirroredDatabaseTableStatus --- # Get-FabricMirroredDatabaseTableStatus ## SYNOPSIS + Retrieves the status of tables in a mirrored database. ## SYNTAX +### __AllParameterSets + ``` -Get-FabricMirroredDatabaseTableStatus [-WorkspaceId] [[-MirroredDatabaseId] ] - [-ProgressAction ] [] +Get-FabricMirroredDatabaseTableStatus [-WorkspaceId] [[-MirroredDatabaseId] ] + [] ``` +## ALIASES + ## DESCRIPTION + Retrieves the status of tables in a mirrored database. The function validates the authentication token, constructs the API endpoint URL, and makes a POST request to retrieve the mirroring status of tables. It handles errors and logs messages at various levels (Debug, Error). @@ -25,70 +35,80 @@ It handles errors and logs messages at various levels (Debug, Error). ## EXAMPLES ### EXAMPLE 1 -``` -Get-FabricMirroredDatabaseTableStatus -WorkspaceId "your-workspace-id" -MirroredDatabaseId "your-mirrored-database-id" + This example retrieves the status of tables in a mirrored database with the specified ID in the specified workspace. + +```powershell +Get-FabricMirroredDatabaseTableStatus -WorkspaceId "your-workspace-id" -MirroredDatabaseId "your-mirrored-database-id" ``` ## PARAMETERS ### -MirroredDatabaseId + The ID of the mirrored database whose table status is to be retrieved. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WorkspaceId + The ID of the workspace containing the mirrored database. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +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, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS -### System.Object[] +### System.Object + +{{ Fill in the Description }} + ## NOTES + The function retrieves the PowerBI access token and makes a POST request to the PowerBI API to retrieve the status of tables in the specified mirrored database. It then returns the 'value' property of the response, which contains the table statuses. Author: Tiago Balabuch ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricMirroredWarehouse.md b/docs/en-US/Get-FabricMirroredWarehouse.md new file mode 100644 index 00000000..4ce0b131 --- /dev/null +++ b/docs/en-US/Get-FabricMirroredWarehouse.md @@ -0,0 +1,138 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricMirroredWarehouse +--- + +# Get-FabricMirroredWarehouse + +## SYNOPSIS + +Retrieves an MirroredWarehouse or a list of MirroredWarehouses from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricMirroredWarehouse [-WorkspaceId] [[-MirroredWarehouseId] ] + [[-MirroredWarehouseName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricMirroredWarehouse` function sends a GET request to the Fabric API to retrieve MirroredWarehouse details for a given workspace. +It can filter the results by `MirroredWarehouseName`. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the "Development" MirroredWarehouse from workspace "12345". + +```powershell +Get-FabricMirroredWarehouse -WorkspaceId "12345" -MirroredWarehouseName "Development" +``` + +### EXAMPLE 2 + +Retrieves all MirroredWarehouses in workspace "12345". + +```powershell +Get-FabricMirroredWarehouse -WorkspaceId "12345" +``` + +## PARAMETERS + +### -MirroredWarehouseId + +(Optional) The ID of a specific MirroredWarehouse to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredWarehouseName + +(Optional) The name of the specific MirroredWarehouse to retrieve. + +```yaml +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 MirroredWarehouses. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricNotebook.md b/docs/en-US/Get-FabricNotebook.md new file mode 100644 index 00000000..62cef473 --- /dev/null +++ b/docs/en-US/Get-FabricNotebook.md @@ -0,0 +1,138 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +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] [[-NotebookId] ] [[-NotebookName] ] + [] +``` + +## 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". + +```powershell +Get-FabricNotebook -WorkspaceId "12345" -NotebookName "Development" +``` + +### EXAMPLE 2 + +Retrieves all Notebooks in workspace "12345". + +```powershell +Get-FabricNotebook -WorkspaceId "12345" +``` + +## PARAMETERS + +### -NotebookId + +(Optional) The ID of a specific Notebook to retrieve. + +```yaml +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. + +```yaml +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. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricNotebookDefinition.md b/docs/en-US/Get-FabricNotebookDefinition.md new file mode 100644 index 00000000..61b90658 --- /dev/null +++ b/docs/en-US/Get-FabricNotebookDefinition.md @@ -0,0 +1,142 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricNotebookDefinition +--- + +# Get-FabricNotebookDefinition + +## SYNOPSIS + +Retrieves the definition of a notebook from a specific workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricNotebookDefinition [-WorkspaceId] [[-NotebookId] ] + [[-NotebookFormat] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function fetches the notebook's content or metadata from a workspace. +It supports retrieving notebook definitions in the Jupyter Notebook (`ipynb`) format. +Handles both synchronous and asynchronous operations, with detailed logging and error handling. + +## EXAMPLES + +### EXAMPLE 1 + +Retrieves the definition of the notebook with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" +``` + +### EXAMPLE 2 + +Retrieves the definitions of all notebooks in the workspace with ID `12345` in the `ipynb` format. + +```powershell +Get-FabricNotebookDefinition -WorkspaceId "12345" +``` + +## PARAMETERS + +### -NotebookFormat + +Specifies the format of the notebook definition. +Currently, only 'ipynb' is supported. +Default: 'ipynb'. + +```yaml +Type: System.String +DefaultValue: ipynb +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookId + +(Optional)The unique identifier of the notebook whose definition needs to be retrieved. + +```yaml +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 + +(Mandatory) The unique identifier of the workspace from which the notebook definition is to be retrieved. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Handles long-running operations asynchronously. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricPaginatedReport.md b/docs/en-US/Get-FabricPaginatedReport.md new file mode 100644 index 00000000..fb72c612 --- /dev/null +++ b/docs/en-US/Get-FabricPaginatedReport.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricPaginatedReport +--- + +# Get-FabricPaginatedReport + +## SYNOPSIS + +Retrieves paginated report details from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricPaginatedReport [-WorkspaceId] [[-PaginatedReportId] ] + [[-PaginatedReportName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves paginated report details from a specified workspace using either the provided PaginatedReportId or PaginatedReportName. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the paginated report details for the report with ID "report-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricPaginatedReports -WorkspaceId "workspace-12345" -PaginatedReportId "report-67890" +``` + +### EXAMPLE 2 + +This example retrieves the paginated report details for the report named "My Paginated Report" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricPaginatedReports -WorkspaceId "workspace-12345" -PaginatedReportName "My Paginated Report" +``` + +## PARAMETERS + +### -PaginatedReportId + +The unique identifier of the paginated report to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PaginatedReportName + +The name of the paginated report to retrieve. +This parameter is optional. + +```yaml +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 paginated reports exist. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricRecoveryPoint.md b/docs/en-US/Get-FabricRecoveryPoint.md new file mode 100644 index 00000000..ab5d9ca0 --- /dev/null +++ b/docs/en-US/Get-FabricRecoveryPoint.md @@ -0,0 +1,186 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricRecoveryPoint +--- + +# Get-FabricRecoveryPoint + +## SYNOPSIS + +Get a list of Fabric recovery points. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricRecoveryPoint [[-WorkspaceGUID] ] [[-DataWarehouseGUID] ] + [[-BaseUrl] ] [[-Since] ] [[-Type] ] [[-CreateTime] ] +``` + +## ALIASES + +## DESCRIPTION + +Get a list of Fabric recovery points. +Results can be filter by date or type. + +## EXAMPLES + +### EXAMPLE 1 + +Gets all the available recovery points for the specified data warehouse, in the specified workspace. + +```powershell +Get-FabricRecoveryPoint -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' +``` + +## PARAMETERS + +### -BaseUrl + +Defaults to api.powerbi.com + +```yaml +Type: System.String +DefaultValue: api.powerbi.com +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CreateTime + +The specific unique time of the restore point to remove. +Get this from Get-FabricRecoveryPoint. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 5 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataWarehouseGUID + +The GUID for the data warehouse which we want to retrieve restore points for. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Since + +Filter the results to only include restore points created after this date. + +```yaml +Type: System.DateTime +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Type + +Filter the results to only include restore points of this type. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceGUID + +This is the workspace GUID in which the data warehouse resides. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +Based on API calls from this blog post: https://blog.fabric.microsoft.com/en-US/blog/the-art-of-data-warehouse-recovery-within-microsoft-fabric/ + +Author: Jess Pomfret + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricReflex.md b/docs/en-US/Get-FabricReflex.md new file mode 100644 index 00000000..a4d77579 --- /dev/null +++ b/docs/en-US/Get-FabricReflex.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricReflex +--- + +# Get-FabricReflex + +## SYNOPSIS + +Retrieves Reflex details from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricReflex [-WorkspaceId] [[-ReflexId] ] [[-ReflexName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves Reflex details from a specified workspace using either the provided ReflexId or ReflexName. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the Reflex details for the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" +``` + +### EXAMPLE 2 + +This example retrieves the Reflex details for the Reflex named "My Reflex" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricReflex -WorkspaceId "workspace-12345" -ReflexName "My Reflex" +``` + +## PARAMETERS + +### -ReflexId + +The unique identifier of the Reflex to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexName + +The name of the Reflex to retrieve. +This parameter is optional. + +```yaml +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 Reflex exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricReflexDefinition.md b/docs/en-US/Get-FabricReflexDefinition.md new file mode 100644 index 00000000..0adfc448 --- /dev/null +++ b/docs/en-US/Get-FabricReflexDefinition.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricReflexDefinition +--- + +# Get-FabricReflexDefinition + +## SYNOPSIS + +Retrieves the definition of an Reflex from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricReflexDefinition [-WorkspaceId] [[-ReflexId] ] [[-ReflexFormat] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves the definition of an Reflex from a specified workspace using the provided ReflexId. +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 Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" +``` + +### EXAMPLE 2 + +This example retrieves the definition of the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345" in JSON format. + +```powershell +Get-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexFormat "json" +``` + +## PARAMETERS + +### -ReflexFormat + +The format in which to retrieve the Reflex definition. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexId + +The unique identifier of the Reflex to retrieve the definition for. +This parameter is optional. + +```yaml +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 Reflex exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricReport.md b/docs/en-US/Get-FabricReport.md new file mode 100644 index 00000000..98205af2 --- /dev/null +++ b/docs/en-US/Get-FabricReport.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricReport +--- + +# Get-FabricReport + +## SYNOPSIS + +Retrieves Report details from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricReport [-WorkspaceId] [[-ReportId] ] [[-ReportName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves Report details from a specified workspace using either the provided ReportId or ReportName. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the Report details for the Report with ID "Report-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" +``` + +### EXAMPLE 2 + +This example retrieves the Report details for the Report named "My Report" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricReport -WorkspaceId "workspace-12345" -ReportName "My Report" +``` + +## PARAMETERS + +### -ReportId + +The unique identifier of the Report to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportName + +The name of the Report to retrieve. +This parameter is optional. + +```yaml +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 Report exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricReportDefinition.md b/docs/en-US/Get-FabricReportDefinition.md new file mode 100644 index 00000000..aa813d34 --- /dev/null +++ b/docs/en-US/Get-FabricReportDefinition.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricReportDefinition +--- + +# Get-FabricReportDefinition + +## SYNOPSIS + +Retrieves the definition of an Report from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricReportDefinition [-WorkspaceId] [[-ReportId] ] [[-ReportFormat] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves the definition of an Report from a specified workspace using the provided ReportId. +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 Report with ID "Report-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" +``` + +### EXAMPLE 2 + +This example retrieves the definition of the Report with ID "Report-67890" in the workspace with ID "workspace-12345" in JSON format. + +```powershell +Get-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportFormat "json" +``` + +## PARAMETERS + +### -ReportFormat + +The format in which to retrieve the Report definition. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportId + +The unique identifier of the Report to retrieve the definition for. +This parameter is optional. + +```yaml +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 Report exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/documentation/Get-FabricSQLDatabase.md b/docs/en-US/Get-FabricSQLDatabase.md similarity index 53% rename from documentation/Get-FabricSQLDatabase.md rename to docs/en-US/Get-FabricSQLDatabase.md index f75d0c53..fbdba1b0 100644 --- a/documentation/Get-FabricSQLDatabase.md +++ b/docs/en-US/Get-FabricSQLDatabase.md @@ -1,30 +1,40 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricSQLDatabase --- # Get-FabricSQLDatabase ## SYNOPSIS + Retrieves Fabric SQL Database details. ## SYNTAX ### WorkspaceId + ``` -Get-FabricSQLDatabase -WorkspaceId [-SQLDatabaseName ] [-SQLDatabaseId ] - [-ProgressAction ] [] +Get-FabricSQLDatabase -WorkspaceId [-SQLDatabaseName ] [-SQLDatabaseId ] + [] ``` ### WorkspaceObject + ``` -Get-FabricSQLDatabase -Workspace [-SQLDatabaseName ] [-SQLDatabaseId ] - [-ProgressAction ] [] +Get-FabricSQLDatabase -Workspace [-SQLDatabaseName ] [-SQLDatabaseId ] + [] ``` +## ALIASES + ## DESCRIPTION + Retrieves Fabric SQL Database details. Without the SQLDatabaseName or SQLDatabaseID parameter, all SQL Databases are returned. @@ -35,7 +45,10 @@ These parameters cannot be used together. ## EXAMPLES ### EXAMPLE 1 -``` + +Returns the details of the Fabric SQL Database with the name 'MySQLDatabase' in the workspace that is specified by the WorkspaceId. + +```powershell $FabricSQLDatabaseConfig = @{ WorkspaceId = '12345678-1234-1234-1234-123456789012' SQLDatabaseName = 'MySQLDatabase' @@ -43,51 +56,34 @@ $FabricSQLDatabaseConfig = @{ Get-FabricSQLDatabase @FabricSQLDatabaseConfig ``` -Returns the details of the Fabric SQL Database with the name 'MySQLDatabase' in the workspace that is specified by the WorkspaceId. - ### EXAMPLE 2 -``` -Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012' -``` Returns the details of the Fabric SQL Databases in the workspace that is specified by the WorkspaceId. -### EXAMPLE 3 -``` -$FabricSQLDatabaseConfig = @{ - WorkspaceId = '12345678-1234-1234-1234-123456789012' - -SQLDatabaseId = '12345678-1234-1234-1234-123456789012' -} -Get-FabricSQLDatabase @FabricSQLDatabaseConfig +```powershell +Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012' ``` +### EXAMPLE 3 + Returns the details of the Fabric SQL Database with the ID '12345678-1234-1234-1234-123456789012' from the workspace with the ID '12345678-1234-1234-1234-123456789012'. -### EXAMPLE 4 -``` -Get-FabricWorkspace -WorkspaceName 'MsLearn-dev' | Get-FabricSQLDatabase +```powershell +Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012' -SQLDatabaseId '12345678-1234-1234-1234-123456789012' ``` -Returns the details of the Fabric SQL Databases in the MsLearn-dev workspace. - -## PARAMETERS +### EXAMPLE 4 -### -ProgressAction -{{ Fill ProgressAction Description }} +Returns the details of the Fabric SQL Databases in the MsLearn-dev workspace. -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +```powershell +Get-FabricWorkspace -WorkspaceName 'MsLearn-dev' | Get-FabricSQLDatabase ``` +## PARAMETERS + ### -SQLDatabaseId + The Id of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseName. The value for SQLDatabaseID is a GUID. @@ -95,74 +91,112 @@ An example of a GUID is '12345678-1234-1234-1234-123456789012'. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: Id - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: +- Id +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -SQLDatabaseName + The name of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseID. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: Name, DisplayName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: +- Name +- DisplayName +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Workspace + The workspace object. This is a mandatory parameter for the 'WorkspaceObject' parameter set and can be pipelined into the function. The object can be easily retrieved by Get-FabricWorkspace function. ```yaml Type: System.Object -Parameter Sets: WorkspaceObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceObject + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WorkspaceId + Id of the Fabric Workspace for which the SQL Databases should be retrieved. The value for WorkspaceId is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'. ```yaml Type: System.Guid -Parameter Sets: WorkspaceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceId + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS +### System.Object + +{{ Fill in the Description }} + ## OUTPUTS ## NOTES + Author: Kamil Nowinski ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricSQLEndpoint.md b/docs/en-US/Get-FabricSQLEndpoint.md new file mode 100644 index 00000000..1aa881b1 --- /dev/null +++ b/docs/en-US/Get-FabricSQLEndpoint.md @@ -0,0 +1,142 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricSQLEndpoint +--- + +# Get-FabricSQLEndpoint + +## SYNOPSIS + +Retrieves SQL Endpoints from a specified workspace in Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricSQLEndpoint [-WorkspaceId] [[-SQLEndpointId] ] [[-SQLEndpointName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricSQLEndpoint` function retrieves SQL Endpoints from a specified workspace in Fabric. +It supports filtering by SQL Endpoint ID or SQL Endpoint Name. +If both filters are provided, +an error message is returned. +The function handles token validation, API requests with continuation +tokens, and processes the response to return the desired SQL Endpoint(s). + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointId "endpoint456" +``` + +### EXAMPLE 2 + +```powershell +Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointName "MySQLEndpoint" +``` + +## PARAMETERS + +### -SQLEndpointId + +The ID of the SQL Endpoint to retrieve. +This parameter is optional but cannot be used together with SQLEndpointName. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SQLEndpointName + +The name of the SQL Endpoint to retrieve. +This parameter is optional but cannot be used together with SQLEndpointId. + +```yaml +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 ID of the workspace from which to retrieve SQL Endpoints. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- This function requires the FabricConfig object to be properly configured with BaseUrl and FabricHeaders. +- The function uses continuation tokens to handle paginated API responses. +- If no filter parameters are provided, all SQL Endpoints in the specified workspace are returned. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricSemanticModel.md b/docs/en-US/Get-FabricSemanticModel.md new file mode 100644 index 00000000..d4b73824 --- /dev/null +++ b/docs/en-US/Get-FabricSemanticModel.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricSemanticModel +--- + +# Get-FabricSemanticModel + +## SYNOPSIS + +Retrieves SemanticModel details from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricSemanticModel [-WorkspaceId] [[-SemanticModelId] ] + [[-SemanticModelName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves SemanticModel details from a specified workspace using either the provided SemanticModelId or SemanticModelName. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the SemanticModel details for the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" +``` + +### EXAMPLE 2 + +This example retrieves the SemanticModel details for the SemanticModel named "My SemanticModel" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelName "My SemanticModel" +``` + +## PARAMETERS + +### -SemanticModelId + +The unique identifier of the SemanticModel to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelName + +The name of the SemanticModel to retrieve. +This parameter is optional. + +```yaml +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 SemanticModel exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricSemanticModelDefinition.md b/docs/en-US/Get-FabricSemanticModelDefinition.md new file mode 100644 index 00000000..238b5939 --- /dev/null +++ b/docs/en-US/Get-FabricSemanticModelDefinition.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +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] [[-SemanticModelId] ] + [[-SemanticModelFormat] ] [] +``` + +## 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". + +```powershell +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. + +```powershell +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. + +```yaml +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. + +```yaml +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. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/documentation/Get-FabricSparkCustomPool.md b/docs/en-US/Get-FabricSparkCustomPool.md similarity index 50% rename from documentation/Get-FabricSparkCustomPool.md rename to docs/en-US/Get-FabricSparkCustomPool.md index 64657579..526ef628 100644 --- a/documentation/Get-FabricSparkCustomPool.md +++ b/docs/en-US/Get-FabricSparkCustomPool.md @@ -1,23 +1,33 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricSparkCustomPool --- # Get-FabricSparkCustomPool ## SYNOPSIS + Retrieves Spark custom pools from a specified workspace. ## SYNTAX +### __AllParameterSets + ``` -Get-FabricSparkCustomPool [-WorkspaceId] [[-SparkCustomPoolId] ] [[-SparkCustomPoolName] ] - [-ProgressAction ] [] +Get-FabricSparkCustomPool [-WorkspaceId] [[-SparkCustomPoolId] ] + [[-SparkCustomPoolName] ] [] ``` +## ALIASES + ## DESCRIPTION + This function retrieves all Spark custom pools from a specified workspace using the provided WorkspaceId. It handles token validation, constructs the API URL, makes the API request, and processes the response. The function supports filtering by SparkCustomPoolId or SparkCustomPoolName, but not both simultaneously. @@ -25,100 +35,117 @@ The function supports filtering by SparkCustomPoolId or SparkCustomPoolName, but ## EXAMPLES ### EXAMPLE 1 -``` -Get-FabricSparkCustomPool -WorkspaceId "12345" + This example retrieves all Spark custom pools from the workspace with ID "12345". + +```powershell +Get-FabricSparkCustomPool -WorkspaceId "12345" ``` ### EXAMPLE 2 -``` -Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolId "pool1" + This example retrieves the Spark custom pool with ID "pool1" from the workspace with ID "12345". + +```powershell +Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolId "pool1" ``` ### EXAMPLE 3 -``` -Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolName "MyPool" + This example retrieves the Spark custom pool with name "MyPool" from the workspace with ID "12345". + +```powershell +Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolName "MyPool" ``` ## PARAMETERS -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SparkCustomPoolId + The ID of the specific Spark custom pool to retrieve. This parameter is optional. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -SparkCustomPoolName + The name of the specific Spark custom pool to retrieve. This parameter is optional. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WorkspaceId + The ID of the workspace from which to retrieve Spark custom pools. This parameter is mandatory. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +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, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. - Handles continuation tokens to retrieve all Spark custom pools if there are multiple pages of results. Author: Tiago Balabuch ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricSparkJobDefinition.md b/docs/en-US/Get-FabricSparkJobDefinition.md new file mode 100644 index 00000000..547b13bb --- /dev/null +++ b/docs/en-US/Get-FabricSparkJobDefinition.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricSparkJobDefinition +--- + +# Get-FabricSparkJobDefinition + +## SYNOPSIS + +Retrieves Spark Job Definition details from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricSparkJobDefinition [-WorkspaceId] [[-SparkJobDefinitionId] ] + [[-SparkJobDefinitionName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves SparkJobDefinition details from a specified workspace using either the provided SparkJobDefinitionId or SparkJobDefinitionName. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the SparkJobDefinition details for the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" +``` + +### EXAMPLE 2 + +This example retrieves the SparkJobDefinition details for the SparkJobDefinition named "My SparkJobDefinition" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionName "My SparkJobDefinition" +``` + +## PARAMETERS + +### -SparkJobDefinitionId + +The unique identifier of the SparkJobDefinition to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionName + +The name of the SparkJobDefinition to retrieve. +This parameter is optional. + +```yaml +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 SparkJobDefinition exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricSparkJobDefinitionDefinition.md b/docs/en-US/Get-FabricSparkJobDefinitionDefinition.md new file mode 100644 index 00000000..0c9c6f45 --- /dev/null +++ b/docs/en-US/Get-FabricSparkJobDefinitionDefinition.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricSparkJobDefinitionDefinition +--- + +# Get-FabricSparkJobDefinitionDefinition + +## SYNOPSIS + +Retrieves the definition of an SparkJobDefinition from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricSparkJobDefinitionDefinition [-WorkspaceId] [[-SparkJobDefinitionId] ] + [[-SparkJobDefinitionFormat] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves the definition of an SparkJobDefinition from a specified workspace using the provided SparkJobDefinitionId. +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 SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" +``` + +### EXAMPLE 2 + +This example retrieves the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" in JSON format. + +```powershell +Get-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionFormat "json" +``` + +## PARAMETERS + +### -SparkJobDefinitionFormat + +The format in which to retrieve the SparkJobDefinition definition. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: SparkJobDefinitionV1 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionId + +The unique identifier of the SparkJobDefinition to retrieve the definition for. +This parameter is optional. + +```yaml +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 SparkJobDefinition exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricSparkSettings.md b/docs/en-US/Get-FabricSparkSettings.md new file mode 100644 index 00000000..eb8d9bb9 --- /dev/null +++ b/docs/en-US/Get-FabricSparkSettings.md @@ -0,0 +1,92 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricSparkSettings +--- + +# Get-FabricSparkSettings + +## SYNOPSIS + +Retrieves Spark settings from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricSparkSettings [-WorkspaceId] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves Spark settings from a specified workspace using the provided WorkspaceId. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the Spark settings for the workspace with ID "workspace-12345". + +```powershell +Get-FabricSparkSettings -WorkspaceId "workspace-12345" +``` + +## PARAMETERS + +### -WorkspaceId + +The unique identifier of the workspace from which to retrieve Spark settings. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +{{ Fill in the Description }} + +## 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 }} + diff --git a/docs/en-US/Get-FabricTenantSetting.md b/docs/en-US/Get-FabricTenantSetting.md new file mode 100644 index 00000000..8e6a7194 --- /dev/null +++ b/docs/en-US/Get-FabricTenantSetting.md @@ -0,0 +1,95 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricTenantSetting +--- + +# Get-FabricTenantSetting + +## SYNOPSIS + +Retrieves tenant settings from the Fabric environment. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricTenantSetting [[-SettingTitle] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricTenantSetting` function retrieves tenant settings for a Fabric environment by making a GET request to the appropriate API endpoint. +Optionally, it filters the results by the `SettingTitle` parameter. + +## EXAMPLES + +### EXAMPLE 1 + +Returns all tenant settings. + +```powershell +Get-FabricTenantSetting +``` + +### EXAMPLE 2 + +Returns the tenant setting with the title "SomeSetting". + +```powershell +Get-FabricTenantSetting -SettingTitle "SomeSetting" +``` + +## PARAMETERS + +### -SettingTitle + +(Optional) The title of a specific tenant setting to filter the results. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Is-TokenExpired` to ensure token validity before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricUsageMetricsQuery.md b/docs/en-US/Get-FabricUsageMetricsQuery.md new file mode 100644 index 00000000..0b4b2b5a --- /dev/null +++ b/docs/en-US/Get-FabricUsageMetricsQuery.md @@ -0,0 +1,155 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricUsageMetricsQuery +--- + +# Get-FabricUsageMetricsQuery + +## SYNOPSIS + +Retrieves usage metrics for a specific dataset. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricUsageMetricsQuery [-DatasetID] [-groupId] [-reportname] + [[-ImpersonatedUser] ] [] +``` + +## ALIASES + +Get-FabUsageMetricsQuery + +## DESCRIPTION + +The Get-FabricUsageMetricsQuery function retrieves usage metrics for a specific dataset. +It supports multiple aliases for flexibility. + +## EXAMPLES + +### EXAMPLE 1 + +Get-FabricUsageMetricsQuery -DatasetID "your-dataset-id" -groupId "your-group-id" -reportname "your-report-name" -token "your-token" + +This example retrieves the usage metrics for a specific dataset given the dataset ID, group ID, report name, and token. + +## PARAMETERS + +### -DatasetID + +The ID of the dataset. +This is a mandatory parameter. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -groupId + +The ID of the group. +This is a mandatory parameter. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ImpersonatedUser + +The name of the impersonated user. +This is an optional parameter. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -reportname + +The name of the report. +This is a mandatory parameter. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +The function defines the headers and body for a POST request to the PowerBI API to retrieve the usage metrics for the specified dataset. +It then makes the POST request and returns the response. + +Author: Ioana Bouariu + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricUserListAccessEntities.md b/docs/en-US/Get-FabricUserListAccessEntities.md new file mode 100644 index 00000000..421b0c5f --- /dev/null +++ b/docs/en-US/Get-FabricUserListAccessEntities.md @@ -0,0 +1,118 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricUserListAccessEntities +--- + +# Get-FabricUserListAccessEntities + +## SYNOPSIS + +Retrieves access entities for a specified user in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricUserListAccessEntities [-UserId] [[-Type] ] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves a list of access entities associated with a specified user in Microsoft Fabric. +It supports filtering by entity type and handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves all access entities associated with the user having ID "user-12345". + +```powershell +Get-FabricUserListAccessEntities -UserId "user-12345" +``` + +### EXAMPLE 2 + +This example retrieves only the 'Dashboard' access entities associated with the user having ID "user-12345". + +```powershell +Get-FabricUserListAccessEntities -UserId "user-12345" -Type "Dashboard" +``` + +## PARAMETERS + +### -Type + +The type of access entity to filter the results by. +This parameter is optional and supports predefined values such as 'CopyJob', 'Dashboard', 'DataPipeline', etc. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -UserId + +The unique identifier of the user whose access entities are to be retrieved. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricWarehouse.md b/docs/en-US/Get-FabricWarehouse.md new file mode 100644 index 00000000..f36861a4 --- /dev/null +++ b/docs/en-US/Get-FabricWarehouse.md @@ -0,0 +1,141 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricWarehouse +--- + +# Get-FabricWarehouse + +## SYNOPSIS + +Retrieves warehouse details from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricWarehouse [-WorkspaceId] [[-WarehouseId] ] [[-WarehouseName] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves warehouse details from a specified workspace using either the provided WarehouseId or WarehouseName. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the warehouse details for the warehouse with ID "warehouse-67890" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" +``` + +### EXAMPLE 2 + +This example retrieves the warehouse details for the warehouse named "My Warehouse" in the workspace with ID "workspace-12345". + +```powershell +Get-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseName "My Warehouse" +``` + +## PARAMETERS + +### -WarehouseId + +The unique identifier of the warehouse to retrieve. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WarehouseName + +The name of the warehouse to retrieve. +This parameter is optional. + +```yaml +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 warehouse exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricWorkspace.md b/docs/en-US/Get-FabricWorkspace.md new file mode 100644 index 00000000..ec5a03cf --- /dev/null +++ b/docs/en-US/Get-FabricWorkspace.md @@ -0,0 +1,117 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricWorkspace +--- + +# Get-FabricWorkspace + +## SYNOPSIS + +Retrieves details of a Microsoft Fabric workspace by its ID or name. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricWorkspace [[-WorkspaceId] ] [[-WorkspaceName] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricWorkspace` function fetches workspace details from the Fabric API. +It supports filtering by WorkspaceId or WorkspaceName. + +## EXAMPLES + +### EXAMPLE 1 + +Fetches details of the workspace with ID "workspace123". + +```powershell +Get-FabricWorkspace -WorkspaceId "workspace123" +``` + +### EXAMPLE 2 + +Fetches details of the workspace with the name "MyWorkspace". + +```powershell +Get-FabricWorkspace -WorkspaceName "MyWorkspace" +``` + +## PARAMETERS + +### -WorkspaceId + +The unique identifier of the workspace to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceName + +The display name of the workspace to retrieve. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Returns the matching workspace details or all workspaces if no filter is provided. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricWorkspaceDatasetRefreshes.md b/docs/en-US/Get-FabricWorkspaceDatasetRefreshes.md new file mode 100644 index 00000000..5fe27f29 --- /dev/null +++ b/docs/en-US/Get-FabricWorkspaceDatasetRefreshes.md @@ -0,0 +1,97 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricWorkspaceDatasetRefreshes +--- + +# Get-FabricWorkspaceDatasetRefreshes + +## SYNOPSIS + +Retrieves the refresh history of all datasets in a specified PowerBI workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricWorkspaceDatasetRefreshes [-WorkspaceID] [] +``` + +## ALIASES + +Get-FabWorkspaceDatasetRefreshes + +## DESCRIPTION + +The Get-FabricWorkspaceDatasetRefreshes function uses the PowerBI cmdlets to retrieve the refresh history of all datasets in a specified workspace. +It uses the workspace ID to get the workspace and its datasets, and then retrieves the refresh history for each dataset. + +## EXAMPLES + +### EXAMPLE 1 + +This command retrieves the refresh history of all datasets in the workspace with the specified ID. .INPUTS String. You can pipe a string that contains the workspace ID to Get-FabricWorkspaceDatasetRefreshes. + +```powershell +Get-FabricWorkspaceDatasetRefreshes -WorkspaceID "12345678-90ab-cdef-1234-567890abcdef" +``` + +## PARAMETERS + +### -WorkspaceID + +The ID of the PowerBI workspace. +This is a mandatory parameter. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Guid. You can pipe a string that contains the workspace ID to Get-FabricWorkspaceDatasetRefreshes. + +{{ Fill in the Description }} + +## OUTPUTS + +### Array. Get-FabricWorkspaceDatasetRefreshes returns an array of refresh history objects. + +{{ Fill in the Description }} + +## NOTES + +Alias: Get-FabWorkspaceDatasetRefreshes + +Author: Ioana Bouariu + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Get-FabricWorkspaceRoleAssignment.md b/docs/en-US/Get-FabricWorkspaceRoleAssignment.md new file mode 100644 index 00000000..5bd0c7eb --- /dev/null +++ b/docs/en-US/Get-FabricWorkspaceRoleAssignment.md @@ -0,0 +1,121 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricWorkspaceRoleAssignment +--- + +# Get-FabricWorkspaceRoleAssignment + +## SYNOPSIS + +Retrieves role assignments for a specified Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricWorkspaceRoleAssignment [-WorkspaceId] [[-WorkspaceRoleAssignmentId] ] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricWorkspaceRoleAssignments` function fetches the role assignments associated with a Fabric workspace by making a GET request to the API. +If `WorkspaceRoleAssignmentId` is provided, it retrieves the specific role assignment. + +## EXAMPLES + +### EXAMPLE 1 + +Fetches all role assignments for the workspace with the ID "workspace123". + +```powershell +Get-FabricWorkspaceRoleAssignments -WorkspaceId "workspace123" +``` + +### EXAMPLE 2 + +Fetches the role assignment with the ID "role123" for the workspace "workspace123". + +```powershell +Get-FabricWorkspaceRoleAssignments -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "role123" +``` + +## PARAMETERS + +### -WorkspaceId + +The unique identifier of the workspace to fetch role assignments for. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceRoleAssignmentId + +(Optional) The unique identifier of a specific role assignment to retrieve. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +{{ Fill in the Description }} + +## 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 }} + diff --git a/docs/en-US/Get-FabricWorkspaceTenantSettingOverrides.md b/docs/en-US/Get-FabricWorkspaceTenantSettingOverrides.md new file mode 100644 index 00000000..7192aeda --- /dev/null +++ b/docs/en-US/Get-FabricWorkspaceTenantSettingOverrides.md @@ -0,0 +1,66 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricWorkspaceTenantSettingOverrides +--- + +# Get-FabricWorkspaceTenantSettingOverrides + +## SYNOPSIS + +Retrieves tenant setting overrides for all workspaces in the Fabric tenant. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricWorkspaceTenantSettingOverrides [] +``` + +## ALIASES + +## DESCRIPTION + +The `Get-FabricWorkspaceTenantSettingOverrides` function retrieves tenant setting overrides for all workspaces in the Fabric tenant by making a GET request to the appropriate API endpoint. +The function validates the authentication token before making the request and handles the response accordingly. + +## EXAMPLES + +### EXAMPLE 1 + +Returns all workspaces tenant setting overrides. + +```powershell +Get-FabricWorkspaceTenantSettingOverrides +``` + +## PARAMETERS + +### 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Get-FabricWorkspaceUsageMetricsData.md b/docs/en-US/Get-FabricWorkspaceUsageMetricsData.md new file mode 100644 index 00000000..ac168bc1 --- /dev/null +++ b/docs/en-US/Get-FabricWorkspaceUsageMetricsData.md @@ -0,0 +1,114 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricWorkspaceUsageMetricsData +--- + +# Get-FabricWorkspaceUsageMetricsData + +## SYNOPSIS + +Retrieves workspace usage metrics data. + +## SYNTAX + +### __AllParameterSets + +``` +Get-FabricWorkspaceUsageMetricsData [-WorkspaceId] [[-username] ] + [] +``` + +## ALIASES + +Get-FabWorkspaceUsageMetricsData + +## DESCRIPTION + +The Get-FabricWorkspaceUsageMetricsData function retrieves workspace usage metrics. +It supports multiple aliases for flexibility. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the workspace usage metrics for a specific workspace given the workspace ID and username. + +```powershell +Get-FabricWorkspaceUsageMetricsData -workspaceId "your-workspace-id" -username "your-username" +``` + +## PARAMETERS + +### -username + +The username. +This is a mandatory parameter. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The ID of the workspace. +This is a mandatory parameter. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +The function retrieves the PowerBI access token and creates a new usage metrics report. +It then defines the names of the reports to retrieve, initializes an empty hashtable to store the reports, and for each report name, retrieves the report and adds it to the hashtable. +It then returns the hashtable of reports. + +Author: Ioana Bouariu + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Get-FabricWorkspaceUser.md b/docs/en-US/Get-FabricWorkspaceUser.md similarity index 52% rename from documentation/Get-FabricWorkspaceUser.md rename to docs/en-US/Get-FabricWorkspaceUser.md index 1721d741..71b5c172 100644 --- a/documentation/Get-FabricWorkspaceUser.md +++ b/docs/en-US/Get-FabricWorkspaceUser.md @@ -1,130 +1,152 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-FabricWorkspaceUser --- # Get-FabricWorkspaceUser ## SYNOPSIS + Retrieves the user(s) of a workspace. ## SYNTAX ### WorkspaceId + ``` -Get-FabricWorkspaceUser -WorkspaceId [-ProgressAction ] [] +Get-FabricWorkspaceUser -WorkspaceId [] ``` ### WorkspaceObject + ``` -Get-FabricWorkspaceUser -Workspace [-ProgressAction ] [] +Get-FabricWorkspaceUser -Workspace [] ``` +## ALIASES + +Get-FabricWorkspaceUsers Get-FabWorkspaceUsers + ## DESCRIPTION + The Get-FabricWorkspaceUser function retrieves the details of the users of a workspace. ## EXAMPLES ### EXAMPLE 1 -``` -Get-FabricWorkspaceUser -WorkspaceId '12345678-1234-1234-1234-123456789012 -``` This example retrieves the users of a workspace of the workspace with the ID '12345678-1234-1234-1234-123456789012'. -### EXAMPLE 2 +```powershell +Get-FabricWorkspaceUser -WorkspaceId '12345678-1234-1234-1234-123456789012 ``` + +### EXAMPLE 2 + +This example retrieves the users of the prod-workspace workspace by piping the object. + +```powershell $workspace = Get-FabricWorkspace -WorkspaceName 'prod-workspace' + $workspace | Get-FabricWorkspaceUser ``` +### EXAMPLE 3 + This example retrieves the users of the prod-workspace workspace by piping the object. -### EXAMPLE 3 -``` +```powershell Get-FabricWorkspaceUser -Workspace (Get-FabricWorkspace -WorkspaceName 'prod-workspace') ``` -This example retrieves the users of the prod-workspace workspace by piping the object. - ### EXAMPLE 4 -``` + +This example retrieves the users of all of the workspaces. IMPORTANT: This will not return the workspace name or ID at present. + +```powershell Get-FabricWorkspace| Get-FabricWorkspaceUser ``` -This example retrieves the users of all of the workspaces. -IMPORTANT: This will not return the workspace name or ID at present. - ### EXAMPLE 5 -``` + +This example retrieves the users of all of the workspaces and returns the workspace name as well. + +```powershell Get-FabricWorkspace| Foreach-Object { -Get-FabricWorkspaceUser -WorkspaceId $_.Id | Select-Object @{Name='WorkspaceName';Expression={$_.displayName;}}, * + Get-FabricWorkspaceUser -WorkspaceId $_.Id | Select-Object @{Name='WorkspaceName';Expression={$_.displayName;}}, * } ``` -This example retrieves the users of all of the workspaces. -It will also add the workspace name to the output. - ## PARAMETERS -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Workspace + The workspace object. This normally comes from the Get-FabricWorkspace cmdlet. This is a mandatory parameter if WorkspaceId is not provided. ```yaml Type: System.Object[] -Parameter Sets: WorkspaceObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceObject + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WorkspaceId + The ID of the workspace. This is a mandatory parameter if Workspace is not provided. ```yaml Type: System.Guid -Parameter Sets: WorkspaceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceId + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS +### System.Object + +{{ Fill in the Description }} + ## OUTPUTS ## NOTES + It supports multiple aliases for backward compatibility. The function defines parameters for the workspace ID and workspace object. If the parameter set name is 'WorkspaceId', it retrieves the workspace object. @@ -133,3 +155,6 @@ It then makes a GET request to the PowerBI API to retrieve the users of the work Author: Ioana Bouariu ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Get-Sha256.md b/docs/en-US/Get-Sha256.md similarity index 60% rename from documentation/Get-Sha256.md rename to docs/en-US/Get-Sha256.md index 35101f6c..bc8affc2 100644 --- a/documentation/Get-Sha256.md +++ b/docs/en-US/Get-Sha256.md @@ -1,49 +1,64 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Get-Sha256 --- # Get-Sha256 ## SYNOPSIS + Calculates the SHA256 hash of a string. ## SYNTAX +### __AllParameterSets + ``` Get-Sha256 [[-string] ] ``` +## ALIASES + ## DESCRIPTION + The Get-Sha256 function calculates the SHA256 hash of a string. ## EXAMPLES ### EXAMPLE 1 -``` + Get-Sha256 -string "your-string" -``` This example calculates the SHA256 hash of a string. ## PARAMETERS ### -string + The string to hash. This is a mandatory parameter. ```yaml Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ## INPUTS @@ -51,8 +66,12 @@ Accept wildcard characters: False ## OUTPUTS ## NOTES + The function creates a new SHA256CryptoServiceProvider object, converts the string to a byte array using UTF8 encoding, computes the SHA256 hash of the byte array, converts the hash to a string and removes any hyphens, and returns the resulting hash. Author: Ioana Bouariu ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Import-FabricEnvironmentStagingLibrary.md b/docs/en-US/Import-FabricEnvironmentStagingLibrary.md new file mode 100644 index 00000000..4b282552 --- /dev/null +++ b/docs/en-US/Import-FabricEnvironmentStagingLibrary.md @@ -0,0 +1,112 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Import-FabricEnvironmentStagingLibrary +--- + +# Import-FabricEnvironmentStagingLibrary + +## SYNOPSIS + +Uploads a library to the staging environment in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Import-FabricEnvironmentStagingLibrary [-WorkspaceId] [-EnvironmentId] + [] +``` + +## ALIASES + +Upload-FabricEnvironmentStagingLibrary + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to upload a library to the specified +environment staging area for the given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Import-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "env-67890" +``` + +## PARAMETERS + +### -EnvironmentId + +The unique identifier of the environment where the library will be uploaded. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the environment exists. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- This is not working code. +It is a placeholder for future development. +Fabric documentation is missing some important details on how to upload libraries. +- 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 }} + diff --git a/docs/en-US/Import-FabricItem.md b/docs/en-US/Import-FabricItem.md new file mode 100644 index 00000000..0825bdeb --- /dev/null +++ b/docs/en-US/Import-FabricItem.md @@ -0,0 +1,196 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Import-FabricItem +--- + +# Import-FabricItem + +## SYNOPSIS + +Imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. + +## SYNTAX + +### __AllParameterSets + +``` +Import-FabricItem [[-path] ] [[-workspaceId] ] [[-filter] ] + [[-fileOverrides] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Import-FabricItem` function imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. +It supports multiple aliases for flexibility. +The function handles the import of datasets and reports, ensuring that the correct item type is used and that the items are created or updated as necessary. + +## EXAMPLES + +### EXAMPLE 1 + +This example imports PBIP files from the 'C:\PBIPFiles' folder into the Fabric workspace with ID '12345'. It only searches for PBIP files in the 'C:\PBIPFiles\Reports' folder. + +```powershell +Import-FabricItem -path 'C:\PBIPFiles' -workspaceId '12345' -filter 'C:\PBIPFiles\Reports' +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -fileOverrides + +This parameter let's you override a PBIP file without altering the local file. + +```yaml +Type: System.Collections.Hashtable +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -filter + +A filter to limit the search for PBIP files to specific folders. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -path + +The path to the PBIP files. +Default value is '.\pbipOutput'. + +```yaml +Type: System.String +DefaultValue: .\pbipOutput +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -workspaceId + +The ID of the Fabric workspace. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +This function requires the Invoke-FabricRestMethod function to be available in the current session. + +Author: Rui Romano + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Invoke-FabricAPIRequest_duplicate.md b/docs/en-US/Invoke-FabricAPIRequest_duplicate.md new file mode 100644 index 00000000..2bb43916 --- /dev/null +++ b/docs/en-US/Invoke-FabricAPIRequest_duplicate.md @@ -0,0 +1,183 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Invoke-FabricAPIRequest_duplicate +--- + +# Invoke-FabricAPIRequest_duplicate + +## SYNOPSIS + +Sends an HTTP request to a Fabric API endpoint and retrieves the response. +Takes care of: authentication, 429 throttling, Long-Running-Operation (LRO) response + +## SYNTAX + +### __AllParameterSets + +``` +Invoke-FabricAPIRequest_duplicate [-Headers] [-BaseURI] [-Method] + [[-Body] ] [[-ContentType] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The Invoke-RestMethod function is used to send an HTTP request to a Fabric API endpoint and retrieve the response. +It handles various aspects such as authentication, 429 throttling, and Long-Running-Operation (LRO) response. + +## EXAMPLES + +### EXAMPLE 1 + +This example sends a GET request to the "/api/resource" endpoint of the Fabric API. ```powershell ``` + +```powershell +Invoke-FabricAPIRequest_duplicate -uri "/api/resource" -method "Get" +``` + +### EXAMPLE 2 + +This example sends a POST request to the "/api/resource" endpoint of the Fabric API with a request body. ```powershell ``` + +```powershell +Invoke-FabricAPIRequest_duplicate -authToken "abc123" -uri "/api/resource" -method "Post" -body $requestBody +``` + +## PARAMETERS + +### -BaseURI + +{{ Fill BaseURI Description }} + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Body + +The body of the request, if applicable. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ContentType + +The content type of the request. +The default value is 'application/json; charset=utf-8'. + +```yaml +Type: System.String +DefaultValue: application/json; charset=utf-8 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Headers + +{{ Fill Headers Description }} + +```yaml +Type: System.Collections.Hashtable +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Method + +The HTTP method to be used for the request. +Valid values are 'Get', 'Post', 'Delete', 'Put', and 'Patch'. +The default value is 'Get'. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +This function requires the Get-FabricAuthToken function to be defined in the same script or module. + +Author: Rui Romano. + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Invoke-FabricDatasetRefresh.md b/docs/en-US/Invoke-FabricDatasetRefresh.md similarity index 50% rename from documentation/Invoke-FabricDatasetRefresh.md rename to docs/en-US/Invoke-FabricDatasetRefresh.md index 6b088490..15ee8c6c 100644 --- a/documentation/Invoke-FabricDatasetRefresh.md +++ b/docs/en-US/Invoke-FabricDatasetRefresh.md @@ -1,22 +1,34 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Invoke-FabricDatasetRefresh --- # Invoke-FabricDatasetRefresh ## SYNOPSIS + This function invokes a refresh of a PowerBI dataset ## SYNTAX +### DatasetId + ``` -Invoke-FabricDatasetRefresh -DatasetID [-ProgressAction ] [] +Invoke-FabricDatasetRefresh -DatasetID [] ``` +## ALIASES + +Invoke-FabDatasetRefresh + ## DESCRIPTION + The Invoke-FabricDatasetRefresh function is used to refresh a PowerBI dataset. It first checks if the dataset is refreshable. If it is not, it writes an error. @@ -26,54 +38,55 @@ The URL for the request is constructed using the provided dataset ID. ## EXAMPLES ### EXAMPLE 1 -``` + Invoke-FabricDatasetRefresh -DatasetID "12345678-1234-1234-1234-123456789012" -``` This command invokes a refresh of the dataset with the ID "12345678-1234-1234-1234-123456789012" ## PARAMETERS ### -DatasetID + A mandatory parameter that specifies the dataset ID. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: DatasetId + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES + Alias: Invoke-FabDatasetRefresh Author: Ioana Bouariu + +Define aliases for the function for flexibility. + ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Invoke-FabricKQLCommand.md b/docs/en-US/Invoke-FabricKQLCommand.md similarity index 52% rename from documentation/Invoke-FabricKQLCommand.md rename to docs/en-US/Invoke-FabricKQLCommand.md index bcea7ab2..83b48ebb 100644 --- a/documentation/Invoke-FabricKQLCommand.md +++ b/docs/en-US/Invoke-FabricKQLCommand.md @@ -1,23 +1,33 @@ ---- -external help file: FabricTools-help.xml +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Invoke-FabricKQLCommand --- # Invoke-FabricKQLCommand ## SYNOPSIS + Executes a KQL command in a Kusto Database. ## SYNTAX +### __AllParameterSets + ``` -Invoke-FabricKQLCommand [-WorkspaceId] [[-KQLDatabaseName] ] [[-KQLDatabaseId] ] - [-KQLCommand] [-ReturnRawResult] [-ProgressAction ] [] +Invoke-FabricKQLCommand [-WorkspaceId] [[-KQLDatabaseName] ] + [[-KQLDatabaseId] ] [-KQLCommand] [-ReturnRawResult] [] ``` +## ALIASES + ## DESCRIPTION + Executes a KQL command in a Kusto Database. The KQL command is executed in the Kusto Database that is specified by the KQLDatabaseName or KQLDatabaseId parameter. The KQL command is executed in the context of the Fabric Real-Time Intelligence session that is established by the Connect-RTISession cmdlet. @@ -25,66 +35,61 @@ The cmdlet distinguishes between management commands and query commands. Management commands are executed in the management API, while query commands are executed in the query API. The distinction is made by checking if the KQL command starts with a dot. If it does, it is a management command else it is a query command. -If the KQL command is a management command, it is crucial to have the execute database script \<| in the beginning, otherwise the Kusto API will not execute the script. -This cmdlet will automatically add the .execute database script \<| in the beginning of the KQL command if it is a management command and if it is not already present. +If the KQL command is a management command, it is crucial to have the execute database script <| in the beginning, otherwise the Kusto API will not execute the script. +This cmdlet will automatically add the .execute database script <| in the beginning of the KQL command if it is a management command and if it is not already present. If the KQL Command is a query command, the result is returned as an array of PowerShell objects by default. If the parameter -ReturnRawResult is used, the raw result of the KQL query is returned which is a JSON object. ## EXAMPLES ### EXAMPLE 1 -``` + +This example will create a table named 'MyTable' with a column named 'MyColumn' in the KQLDatabase 'MyKQLDatabase'. + +```powershell Invoke-FabricKQLCommand -WorkspaceId '12345678-1234-1234-1234-123456789012' -KQLDatabaseName 'MyKQLDatabase'-KQLCommand '.create table MyTable (MyColumn: string) ``` -This example will create a table named 'MyTable' with a column named 'MyColumn' in -the KQLDatabase 'MyKQLDatabase'. - ### EXAMPLE 2 -``` -Invoke-FabricKQLCommand ` - -WorkspaceId '2c4ccbb5-9b13-4495-9ab3-ba41152733d9' ` - -KQLDatabaseName 'MyEventhouse2' ` - -KQLCommand 'productcategory - | take 100' -``` -This example will Execute the Query 'productcategory | take 100' in the KQLDatabase 'MyEventhouse2' -and it will return the result as an array of PowerShell objects. +This example will Execute the Query 'productcategory | take 100' in the KQLDatabase 'MyEventhouse2' and it will return the result as an array of PowerShell objects. -### EXAMPLE 3 -``` +```powershell Invoke-FabricKQLCommand ` - -WorkspaceId '2c4ccbb5-9b13-4495-9ab3-ba41152733d9' ` - -KQLDatabaseName 'MyEventhouse2' ` - -ReturnRawResult ` - -KQLCommand 'productcategory - | take 100' + -WorkspaceId '2c4ccbb5-9b13-4495-9ab3-ba41152733d9' ` + -KQLDatabaseName 'MyEventhouse2' ` + -ReturnRawResult ` + -KQLCommand 'productcategory + | take 100' ``` -This example will Execute the Query 'productcategory | take 100' in the KQLDatabase 'MyEventhouse2' -and it will return the result as the raw result of the KQL command, which is a JSON object. - ## PARAMETERS ### -KQLCommand + The KQL command that should be executed in the Kusto Database. The KQL command is a string. An example of a string is '.create table MyTable (MyColumn: string)'. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -KQLDatabaseId + The Id of the KQLDatabase in which the KQL command should be executed. This parameter cannot be used together with KQLDatabaseName. The value for KQLDatabaseId is a GUID. @@ -92,89 +97,102 @@ An example of a GUID is '12345678-1234-1234-1234-123456789012'. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -KQLDatabaseName + The name of the KQLDatabase in which the KQL command should be executed. This parameter cannot be used together with KQLDatabaseId. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -ReturnRawResult + When this switch is used, the raw result of the KQL command is returned. By default, the result is returned as a PowerShell object. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WorkspaceId + Id of the Fabric Workspace for which the KQL command should be executed. The value for WorkspaceId is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'. ```yaml Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +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, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES + Revision History: 2024-12-22 - FGE: Added Verbose Output @@ -183,3 +201,6 @@ Revision History: Author: Frank Geisler ## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Invoke-FabricRestMethod.md b/docs/en-US/Invoke-FabricRestMethod.md new file mode 100644 index 00000000..81a69e77 --- /dev/null +++ b/docs/en-US/Invoke-FabricRestMethod.md @@ -0,0 +1,179 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Invoke-FabricRestMethod +--- + +# Invoke-FabricRestMethod + +## SYNOPSIS + +Sends an HTTP request to a Fabric API endpoint and retrieves the response. + +## SYNTAX + +### __AllParameterSets + +``` +Invoke-FabricRestMethod [-Uri] [[-Method] ] [[-Body] ] [-TestTokenExpired] + [-PowerBIApi] [] +``` + +## ALIASES + +## DESCRIPTION + +The Invoke-FabricRestMethod function is used to send an HTTP request to a Fabric API endpoint and retrieve the response. + +## EXAMPLES + +### EXAMPLE 1 + +Invoke-FabricRestMethod -uri "/api/resource" -method "GET" + +This example sends a GET request to the "/api/resource" endpoint of the Fabric API. + +### EXAMPLE 2 + +Invoke-FabricRestMethod -uri "/api/resource" -method "POST" -body $requestBody + +This example sends a POST request to the "/api/resource" endpoint of the Fabric API with a request body. + +## PARAMETERS + +### -Body + +The body of the request, if applicable. +This can be a hashtable or a string. +If a hashtable is provided, it will be converted to JSON format. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Method + +The HTTP method to be used for the request. +Valid values are 'GET', 'POST', 'DELETE', 'PUT', and 'PATCH'. +The default value is 'GET'. + +```yaml +Type: System.String +DefaultValue: GET +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PowerBIApi + +A switch parameter to indicate that the request should be sent to the Power BI API instead of the Fabric API. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TestTokenExpired + +A switch parameter to test if the Fabric token is expired before making the request. +If the token is expired, it will attempt to refresh it. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Uri + +The URI of the Fabric API endpoint to send the request to. + +```yaml +Type: System.String +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl`. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Invoke-FabricRestMethodExtended.md b/docs/en-US/Invoke-FabricRestMethodExtended.md new file mode 100644 index 00000000..e6badbd4 --- /dev/null +++ b/docs/en-US/Invoke-FabricRestMethodExtended.md @@ -0,0 +1,160 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Invoke-FabricRestMethodExtended +--- + +# Invoke-FabricRestMethodExtended + +## SYNOPSIS + +Sends an HTTP request to a Fabric API endpoint and retrieves the response. +Takes care of: authentication, 429 throttling, Long-Running-Operation (LRO) response + +## SYNTAX + +### __AllParameterSets + +``` +Invoke-FabricRestMethodExtended [-Uri] [[-Method] ] [[-Body] ] + [[-RetryCount] ] [] +``` + +## ALIASES + +## DESCRIPTION + +The Invoke-FabricRestMethodExtended function is used to send an HTTP request to a Fabric API endpoint and retrieve the response. +It handles various aspects such as authentication, 429 throttling, and Long-Running-Operation (LRO) response. + +## EXAMPLES + +### EXAMPLE 1 + +Invoke-FabricRestMethodExtended -Uri "/api/resource" -Method "GET" + +This example sends a GET request to the "/api/resource" endpoint of the Fabric API. + +### EXAMPLE 2 + +Invoke-FabricRestMethodExtended -Uri "/api/resource" -method "POST" -Body $requestBody + +This example sends a POST request to the "/api/resource" endpoint of the Fabric API with a request body. + +## PARAMETERS + +### -Body + +The body of the request, if applicable. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Method + +The HTTP method to be used for the request. +Valid values are 'GET', 'POST', 'DELETE', 'PUT', and 'PATCH'. +The default value is 'GET'. + +```yaml +Type: System.String +DefaultValue: GET +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -RetryCount + +The number of times to retry the request in case of a 429 (Too Many Requests) error. +The default value is 0. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Uri + +The URI of the Fabric API endpoint to send the request to. + +```yaml +Type: System.String +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +This function based on code that was originally written by Rui Romano (Invoke-FabricAPIRequest) and replaces it. +It's extended version of simple Invoke-FabricRestMethod function. +Requires `$FabricConfig` global configuration, including `BaseUrl`. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/New-FabricCopyJob.md b/docs/en-US/New-FabricCopyJob.md new file mode 100644 index 00000000..1deb5853 --- /dev/null +++ b/docs/en-US/New-FabricCopyJob.md @@ -0,0 +1,219 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricCopyJob +--- + +# New-FabricCopyJob + +## SYNOPSIS + +Creates a new copy job in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricCopyJob [-WorkspaceId] [-CopyJobName] [[-CopyJobDescription] ] + [[-CopyJobPathDefinition] ] [[-CopyJobPathPlatformDefinition] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +Sends a POST request to the Microsoft Fabric API to create a new copy job in the specified workspace. +Supports optional parameters for description and definition files. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a new copy job named "New Copy Job" in the workspace with ID "workspace-12345". + +```powershell +New-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobName "New Copy Job" -CopyJobDescription "Description of the new copy job" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobDescription + +Optional description for the copy job. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobName + +The name of the copy job to be created. +Mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobPathDefinition + +Optional file path to the copy job definition JSON file. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobPathPlatformDefinition + +Optional file path to the platform definition file. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the copy job will be created. +Mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricDataPipeline.md b/docs/en-US/New-FabricDataPipeline.md new file mode 100644 index 00000000..cf52e7ce --- /dev/null +++ b/docs/en-US/New-FabricDataPipeline.md @@ -0,0 +1,176 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricDataPipeline +--- + +# New-FabricDataPipeline + +## SYNOPSIS + +Creates a new DataPipeline in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricDataPipeline [-WorkspaceId] [-DataPipelineName] + [[-DataPipelineDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new DataPipeline +in the specified workspace. +It supports optional parameters for DataPipeline description +and path definitions for the DataPipeline content. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new DataPipeline named "New DataPipeline" in the workspace with ID "workspace-12345" and uploads the definition file from the specified path. + +```powershell +New-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineName "New DataPipeline" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataPipelineDescription + +An optional description for the DataPipeline. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataPipelineName + +The name of the DataPipeline to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the DataPipeline will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricDeploymentPipeline.md b/docs/en-US/New-FabricDeploymentPipeline.md new file mode 100644 index 00000000..e63d28cc --- /dev/null +++ b/docs/en-US/New-FabricDeploymentPipeline.md @@ -0,0 +1,188 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricDeploymentPipeline +--- + +# New-FabricDeploymentPipeline + +## SYNOPSIS + +Creates a new deployment pipeline. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricDeploymentPipeline [-DisplayName] [[-Description] ] [-Stages] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `New-FabricDeploymentPipeline` function creates a new deployment pipeline with specified stages. +Each stage can be configured with a display name, description, and public/private visibility setting. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a new deployment pipeline with two stages. + +```powershell +New-FabricDeploymentPipeline -DisplayName "My Deployment Pipeline" -Description "This is a test deployment pipeline" -Stages @( + @{ DisplayName = "Stage 1"; Description = "First stage"; IsPublic = $true }, + @{ DisplayName = "Stage 2"; Description = "Second stage"; IsPublic = $false } +) +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Description + +Optional. +The description for the deployment pipeline. +Maximum length is 1024 characters. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DisplayName + +Required. +The display name for the deployment pipeline. +Maximum length is 256 characters. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Stages + +Required. +An array of hashtables containing stage configurations. +Each stage should have: +- DisplayName (string, max 256 chars) +- Description (string, max 1024 chars) +- IsPublic (boolean) + +```yaml +Type: System.Array +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Requires Pipeline.ReadWrite.All delegated scope. +- Service Principals must have permission granted by Fabric administrator. +- Returns the created deployment pipeline object with assigned IDs for the pipeline and its stages. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/New-FabricDomain.md b/docs/en-US/New-FabricDomain.md new file mode 100644 index 00000000..70f63086 --- /dev/null +++ b/docs/en-US/New-FabricDomain.md @@ -0,0 +1,174 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricDomain +--- + +# New-FabricDomain + +## SYNOPSIS + +Creates a new Fabric domain. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricDomain [-DomainName] [[-DomainDescription] ] [[-ParentDomainId] ] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Add-FabricDomain` function creates a new domain in Microsoft Fabric by making a POST request to the relevant API endpoint. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a "Finance" domain under the parent domain with ID "12345". + +```powershell +Add-FabricDomain -DomainName "Finance" -DomainDescription "Finance data domain" -ParentDomainId "12345" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainDescription + +A description of the domain to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainName + +The name of the domain to be created. +Must only contain alphanumeric characters, underscores, and spaces. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ParentDomainId + +(Optional) The ID of the parent domain, if applicable. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricEnvironment.md b/docs/en-US/New-FabricEnvironment.md new file mode 100644 index 00000000..36a9ee67 --- /dev/null +++ b/docs/en-US/New-FabricEnvironment.md @@ -0,0 +1,175 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricEnvironment +--- + +# New-FabricEnvironment + +## SYNOPSIS + +Creates a new environment in a specified workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricEnvironment [-WorkspaceId] [-EnvironmentName] + [[-EnvironmentDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Add-FabricEnvironment` function creates a new environment within a given workspace by making a POST request to the Fabric API. +The environment can optionally include a description. + +## EXAMPLES + +### EXAMPLE 1 + +Creates an environment named "DevEnv" in workspace "12345" with the specified description. + +```powershell +Add-FabricEnvironment -WorkspaceId "12345" -EnvironmentName "DevEnv" -EnvironmentDescription "Development Environment" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentDescription + +(Optional) A description of the environment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentName + +(Mandatory) The name of the environment to be created. +Only alphanumeric characters, spaces, and underscores are allowed. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace where the environment will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricEventhouse.md b/docs/en-US/New-FabricEventhouse.md new file mode 100644 index 00000000..ceda2467 --- /dev/null +++ b/docs/en-US/New-FabricEventhouse.md @@ -0,0 +1,220 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricEventhouse +--- + +# New-FabricEventhouse + +## SYNOPSIS + +Creates a new Eventhouse in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricEventhouse [-WorkspaceId] [-EventhouseName] + [[-EventhouseDescription] ] [[-EventhousePathDefinition] ] + [[-EventhousePathPlatformDefinition] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new Eventhouse +in the specified workspace. +It supports optional parameters for Eventhouse description and path definitions. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new Eventhouse named "New Eventhouse" in the workspace with ID "workspace-12345" with the provided description. + +```powershell +New-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseName "New Eventhouse" -EventhouseDescription "Description of the new Eventhouse" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhouseDescription + +An optional description for the Eventhouse. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhouseName + +The name of the Eventhouse to be created. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhousePathDefinition + +An optional path to the Eventhouse definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhousePathPlatformDefinition + +An optional path to the platform-specific definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Eventhouse will be created. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricEventstream.md b/docs/en-US/New-FabricEventstream.md new file mode 100644 index 00000000..d23c21ba --- /dev/null +++ b/docs/en-US/New-FabricEventstream.md @@ -0,0 +1,219 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricEventstream +--- + +# New-FabricEventstream + +## SYNOPSIS + +Creates a new Eventstream in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricEventstream [-WorkspaceId] [-EventstreamName] + [[-EventstreamDescription] ] [[-EventstreamPathDefinition] ] + [[-EventstreamPathPlatformDefinition] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new Eventstream +in the specified workspace. +It supports optional parameters for Eventstream description +and path definitions for the Eventstream content. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a new Eventstream named "New Eventstream" in the workspace with ID "workspace-12345". + +```powershell +New-FabricEventstream -WorkspaceId "workspace-12345" -EventstreamName "New Eventstream" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamDescription + +An optional description for the Eventstream. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamName + +The name of the Eventstream to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamPathDefinition + +An optional path to the Eventstream definition file (e.g., .ipynb file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamPathPlatformDefinition + +An optional path to the platform-specific definition (e.g., .platform file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Eventstream will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricKQLDashboard.md b/docs/en-US/New-FabricKQLDashboard.md new file mode 100644 index 00000000..5006abac --- /dev/null +++ b/docs/en-US/New-FabricKQLDashboard.md @@ -0,0 +1,227 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricKQLDashboard +--- + +# New-FabricKQLDashboard + +## SYNOPSIS + +Creates a new KQLDashboard in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricKQLDashboard [-WorkspaceId] [-KQLDashboardName] + [[-KQLDashboardDescription] ] [[-KQLDashboardPathDefinition] ] + [[-KQLDashboardPathPlatformDefinition] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new KQLDashboard +in the specified workspace. +It supports optional parameters for KQLDashboard description +and path definitions for the KQLDashboard content. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a new KQLDashboard named "New KQLDashboard" in the workspace with ID "workspace-12345". + +```powershell +New-FabricKQLDashboard -WorkspaceId "workspace-12345" -KQLDashboardName "New KQLDashboard" +``` + +### EXAMPLE 2 + +Creates a new KQLDashboard with a definition file and platform definition. + +```powershell +New-FabricKQLDashboard -WorkspaceId "workspace-12345" -KQLDashboardName "New KQLDashboard" -KQLDashboardPathDefinition "C:\KQLDashboards\example.ipynb" -KQLDashboardPathPlatformDefinition "C:\KQLDashboards\platform.json" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardDescription + +An optional description for the KQLDashboard. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardName + +The name of the KQLDashboard to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardPathDefinition + +An optional path to the KQLDashboard definition file (e.g., .ipynb file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardPathPlatformDefinition + +An optional path to the platform-specific definition (e.g., .platform file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the KQLDashboard will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricKQLDatabase.md b/docs/en-US/New-FabricKQLDatabase.md new file mode 100644 index 00000000..0bc61093 --- /dev/null +++ b/docs/en-US/New-FabricKQLDatabase.md @@ -0,0 +1,354 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricKQLDatabase +--- + +# New-FabricKQLDatabase + +## SYNOPSIS + +Creates a new KQLDatabase in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricKQLDatabase [-WorkspaceId] [-KQLDatabaseName] + [[-KQLDatabaseDescription] ] [[-parentEventhouseId] ] [-KQLDatabaseType] + [[-KQLInvitationToken] ] [[-KQLSourceClusterUri] ] + [[-KQLSourceDatabaseName] ] [[-KQLDatabasePathDefinition] ] + [[-KQLDatabasePathPlatformDefinition] ] [[-KQLDatabasePathSchemaDefinition] ] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new KQLDatabase +in the specified workspace. +It supports optional parameters for KQLDatabase description +and path definitions for the KQLDatabase content. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a new KQLDatabase named "New KQLDatabase" in the workspace with ID "workspace-12345". + +```powershell +New-FabricKQLDatabase -WorkspaceId "workspace-12345" -KQLDatabaseName "New KQLDatabase" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseDescription + +An optional description for the KQLDatabase. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseName + +The name of the KQLDatabase to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabasePathDefinition + +An optional path to the KQLDatabase definition file (e.g., .ipynb file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 8 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabasePathPlatformDefinition + +An optional path to the platform-specific definition (e.g., .platform file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 9 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabasePathSchemaDefinition + +the path to the KQLDatabase schema definition file (e.g., .kql file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 10 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseType + +The type of KQLDatabase to create. +Valid values are "ReadWrite" and "Shortcut". + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLInvitationToken + +An optional invitation token for the KQLDatabase. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 5 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLSourceClusterUri + +An optional source cluster URI for the KQLDatabase. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 6 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLSourceDatabaseName + +An optional source database name for the KQLDatabase. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 7 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -parentEventhouseId + +The ID of the parent Eventhouse item for the KQLDatabase. +This is mandatory for ReadWrite type databases. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the KQLDatabase will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Precedent Request Body + - Definition file high priority. + - CreationPayload is evaluate only if Definition file is not provided. + - invitationToken has priority over all other payload fields. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/New-FabricKQLQueryset.md b/docs/en-US/New-FabricKQLQueryset.md new file mode 100644 index 00000000..d6520f7d --- /dev/null +++ b/docs/en-US/New-FabricKQLQueryset.md @@ -0,0 +1,219 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricKQLQueryset +--- + +# New-FabricKQLQueryset + +## SYNOPSIS + +Creates a new KQLQueryset in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricKQLQueryset [-WorkspaceId] [-KQLQuerysetName] + [[-KQLQuerysetDescription] ] [[-KQLQuerysetPathDefinition] ] + [[-KQLQuerysetPathPlatformDefinition] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new KQLQueryset +in the specified workspace. +It supports optional parameters for KQLQueryset description +and path definitions for the KQLQueryset content. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a new KQLQueryset named "New KQLQueryset" in the specified workspace with a path to the definition file. + +```powershell +New-FabricKQLQueryset -WorkspaceId "workspace-12345" -KQLQuerysetName "New KQLQueryset" -KQLQuerysetPathDefinition "C:\kql\example.ipynb" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetDescription + +An optional description for the KQLQueryset. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetName + +The name of the KQLQueryset to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetPathDefinition + +An optional path to the KQLQueryset definition file (e.g., .ipynb file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetPathPlatformDefinition + +An optional path to the platform-specific definition (e.g., .platform file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the KQLQueryset will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricLakehouse.md b/docs/en-US/New-FabricLakehouse.md new file mode 100644 index 00000000..80c71d49 --- /dev/null +++ b/docs/en-US/New-FabricLakehouse.md @@ -0,0 +1,198 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricLakehouse +--- + +# New-FabricLakehouse + +## SYNOPSIS + +Creates a new Lakehouse in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricLakehouse [-WorkspaceId] [-LakehouseName] + [[-LakehouseDescription] ] [[-LakehouseEnableSchemas] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new Lakehouse +in the specified workspace. +It supports optional parameters for Lakehouse description +and path definitions for the Lakehouse content. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a new Lakehouse in the specified workspace with a given name and enable schemas option. + +```powershell +New-FabricLakehouse -WorkspaceId "workspace-12345" -LakehouseName "New Lakehouse" -LakehouseEnableSchemas $true +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseDescription + +An optional description for the Lakehouse. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseEnableSchemas + +An optional path to enable schemas in the Lakehouse + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseName + +The name of the Lakehouse to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Lakehouse will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricMLExperiment.md b/docs/en-US/New-FabricMLExperiment.md new file mode 100644 index 00000000..7652d1df --- /dev/null +++ b/docs/en-US/New-FabricMLExperiment.md @@ -0,0 +1,177 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricMLExperiment +--- + +# New-FabricMLExperiment + +## SYNOPSIS + +Creates a new ML Experiment in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricMLExperiment [-WorkspaceId] [-MLExperimentName] + [[-MLExperimentDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new ML Experiment +in the specified workspace. +It supports optional parameters for ML Experiment description. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new ML Experiment named "New ML Experiment" in the workspace with ID "workspace-12345" with the provided description. + +```powershell +New-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentName "New ML Experiment" -MLExperimentDescription "Description of the new ML Experiment" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLExperimentDescription + +An optional description for the ML Experiment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLExperimentName + +The name of the ML Experiment to be created. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the ML Experiment will be created. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricMLModel.md b/docs/en-US/New-FabricMLModel.md new file mode 100644 index 00000000..da249d16 --- /dev/null +++ b/docs/en-US/New-FabricMLModel.md @@ -0,0 +1,177 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricMLModel +--- + +# New-FabricMLModel + +## SYNOPSIS + +Creates a new ML Model in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricMLModel [-WorkspaceId] [-MLModelName] [[-MLModelDescription] ] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new ML Model +in the specified workspace. +It supports optional parameters for ML Model description. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new ML Model named "New ML Model" in the workspace with ID "workspace-12345" with the provided description. + +```powershell +New-FabricMLModel -WorkspaceId "workspace-12345" -MLModelName "New ML Model" -MLModelDescription "Description of the new ML Model" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLModelDescription + +An optional description for the ML Model. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLModelName + +The name of the ML Model to be created. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the ML Model will be created. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricMirroredDatabase.md b/docs/en-US/New-FabricMirroredDatabase.md new file mode 100644 index 00000000..db75b06b --- /dev/null +++ b/docs/en-US/New-FabricMirroredDatabase.md @@ -0,0 +1,217 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricMirroredDatabase +--- + +# New-FabricMirroredDatabase + +## SYNOPSIS + +Creates a new MirroredDatabase in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricMirroredDatabase [-WorkspaceId] [-MirroredDatabaseName] + [[-MirroredDatabaseDescription] ] [[-MirroredDatabasePathDefinition] ] + [[-MirroredDatabasePathPlatformDefinition] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new MirroredDatabase +in the specified workspace. +It supports optional parameters for MirroredDatabase description +and path definitions for the MirroredDatabase content. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Add-FabricMirroredDatabase -WorkspaceId "workspace-12345" -MirroredDatabaseName "New MirroredDatabase" -MirroredDatabasePathDefinition "C:\MirroredDatabases\example.json" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseDescription + +An optional description for the MirroredDatabase. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseName + +The name of the MirroredDatabase to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabasePathDefinition + +An optional path to the MirroredDatabase definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabasePathPlatformDefinition + +An optional path to the platform-specific definition (e.g., .platform file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the MirroredDatabase will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricNotebook.md b/docs/en-US/New-FabricNotebook.md new file mode 100644 index 00000000..7996c38b --- /dev/null +++ b/docs/en-US/New-FabricNotebook.md @@ -0,0 +1,219 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricNotebook +--- + +# New-FabricNotebook + +## SYNOPSIS + +Creates a new notebook in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricNotebook [-WorkspaceId] [-NotebookName] [[-NotebookDescription] ] + [[-NotebookPathDefinition] ] [[-NotebookPathPlatformDefinition] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new notebook +in the specified workspace. +It supports optional parameters for notebook description +and path definitions for the notebook content. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a new notebook in the specified workspace with a given name and path definition. + +```powershell +New-FabricNotebook -WorkspaceId "workspace-12345" -NotebookName "New Notebook" -NotebookPathDefinition "C:\notebooks\example.ipynb" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookDescription + +An optional description for the notebook. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookName + +The name of the notebook to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookPathDefinition + +An optional path to the notebook definition file (e.g., .ipynb file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookPathPlatformDefinition + +An optional path to the platform-specific definition (e.g., .platform file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the notebook will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricNotebookNEW.md b/docs/en-US/New-FabricNotebookNEW.md new file mode 100644 index 00000000..a5223eea --- /dev/null +++ b/docs/en-US/New-FabricNotebookNEW.md @@ -0,0 +1,196 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricNotebookNEW +--- + +# New-FabricNotebookNEW + +## SYNOPSIS + +Creates a new notebook in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricNotebookNEW [-WorkspaceId] [-NotebookName] + [[-NotebookDescription] ] [[-NotebookPathDefinition] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new notebook +in the specified workspace. +It supports optional parameters for notebook description +and path definitions for the notebook content. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Add-FabricNotebook -WorkspaceId "workspace-12345" -NotebookName "New Notebook" -NotebookPathDefinition "C:\notebooks\example.ipynb" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookDescription + +An optional description for the notebook. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookName + +The name of the notebook to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookPathDefinition + +An optional path to the notebook definition file (e.g., .ipynb file) to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the notebook will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricRecoveryPoint.md b/docs/en-US/New-FabricRecoveryPoint.md new file mode 100644 index 00000000..09e10aa4 --- /dev/null +++ b/docs/en-US/New-FabricRecoveryPoint.md @@ -0,0 +1,176 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricRecoveryPoint +--- + +# New-FabricRecoveryPoint + +## SYNOPSIS + +Create a recovery point for a Fabric data warehouse + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricRecoveryPoint [[-WorkspaceGUID] ] [[-DataWarehouseGUID] ] + [[-BaseUrl] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +Create a recovery point for a Fabric data warehouse + +## EXAMPLES + +### EXAMPLE 1 + +New-FabricRecoveryPoint + +Create a new recovery point for the data warehouse specified in the configuration. + +### EXAMPLE 2 + +Create a new recovery point for the specified data warehouse, in the specified workspace. + +```powershell +New-FabricRecoveryPoint -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' +``` + +## PARAMETERS + +### -BaseUrl + +Defaults to api.powerbi.com + +```yaml +Type: System.String +DefaultValue: api.powerbi.com +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataWarehouseGUID + +The GUID for the data warehouse which we want to retrieve restore points for. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceGUID + +This is the workspace GUID in which the data warehouse resides. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Jess Pomfret + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/New-FabricReflex.md b/docs/en-US/New-FabricReflex.md new file mode 100644 index 00000000..1be43369 --- /dev/null +++ b/docs/en-US/New-FabricReflex.md @@ -0,0 +1,220 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricReflex +--- + +# New-FabricReflex + +## SYNOPSIS + +Creates a new Reflex in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricReflex [-WorkspaceId] [-ReflexName] [[-ReflexDescription] ] + [[-ReflexPathDefinition] ] [[-ReflexPathPlatformDefinition] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new Reflex +in the specified workspace. +It supports optional parameters for Reflex description and path definitions. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new Reflex named "New Reflex" in the workspace with ID "workspace-12345" with the provided description. + +```powershell +New-FabricReflex -WorkspaceId "workspace-12345" -ReflexName "New Reflex" -ReflexDescription "Description of the new Reflex" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexDescription + +An optional description for the Reflex. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexName + +The name of the Reflex to be created. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexPathDefinition + +An optional path to the Reflex definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexPathPlatformDefinition + +An optional path to the platform-specific definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Reflex will be created. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricReport.md b/docs/en-US/New-FabricReport.md new file mode 100644 index 00000000..6cf0c29b --- /dev/null +++ b/docs/en-US/New-FabricReport.md @@ -0,0 +1,198 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricReport +--- + +# New-FabricReport + +## SYNOPSIS + +Creates a new Report in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricReport [-WorkspaceId] [-ReportName] [[-ReportDescription] ] + [-ReportPathDefinition] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new Report +in the specified workspace. +It supports optional parameters for Report description and path definitions. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new Report named "New Report" in the workspace with ID "workspace-12345" with the provided description. + +```powershell +New-FabricReport -WorkspaceId "workspace-12345" -ReportName "New Report" -ReportDescription "Description of the new Report" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportDescription + +An optional description for the Report. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportName + +The name of the Report to be created. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportPathDefinition + +A mandatory path to the folder that contains Report definition files to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Report will be created. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricSQLDatabase.md b/docs/en-US/New-FabricSQLDatabase.md new file mode 100644 index 00000000..c6257774 --- /dev/null +++ b/docs/en-US/New-FabricSQLDatabase.md @@ -0,0 +1,194 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricSQLDatabase +--- + +# New-FabricSQLDatabase + +## SYNOPSIS + +Creates a new SQL Database in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricSQLDatabase [-WorkspaceId] [-Name] [[-Description] ] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `New-FabricSQLDatabase` function sends a POST request to the Microsoft Fabric API to create a new SQL Database +in the specified workspace. +It supports optional parameters for SQL Database description +and path definitions for the SQL Database content. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +New-FabricSQLDatabase -WorkspaceId "workspace-12345" -Name "NewDatabase" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Description + +An optional description for the SQL Database. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Name + +The name of the SQL Database to be created. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NoWait + +If specified, the function will not wait for the operation to complete and will return immediately. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the SQL Database will be created. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/New-FabricSemanticModel.md b/docs/en-US/New-FabricSemanticModel.md new file mode 100644 index 00000000..2004cef1 --- /dev/null +++ b/docs/en-US/New-FabricSemanticModel.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricSemanticModel +--- + +# New-FabricSemanticModel + +## SYNOPSIS + +Creates a new SemanticModel in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricSemanticModel [-WorkspaceId] [-SemanticModelName] + [[-SemanticModelDescription] ] [-SemanticModelPathDefinition] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new SemanticModel +in the specified workspace. +It supports optional parameters for SemanticModel description and path definitions. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new SemanticModel named "New SemanticModel" in the workspace with ID "workspace-12345" with the provided description. + +```powershell +New-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelName "New SemanticModel" -SemanticModelDescription "Description of the new SemanticModel" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelDescription + +An optional description for the SemanticModel. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelName + +The name of the SemanticModel to be created. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelPathDefinition + +An optional path to the SemanticModel definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the SemanticModel will be created. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricSparkCustomPool.md b/docs/en-US/New-FabricSparkCustomPool.md new file mode 100644 index 00000000..f416d31e --- /dev/null +++ b/docs/en-US/New-FabricSparkCustomPool.md @@ -0,0 +1,335 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricSparkCustomPool +--- + +# New-FabricSparkCustomPool + +## SYNOPSIS + +Creates a new Spark custom pool in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricSparkCustomPool [-WorkspaceId] [-SparkCustomPoolName] + [-NodeFamily] [-NodeSize] [-AutoScaleEnabled] + [-AutoScaleMinNodeCount] [-AutoScaleMaxNodeCount] + [-DynamicExecutorAllocationEnabled] [-DynamicExecutorAllocationMinExecutors] + [-DynamicExecutorAllocationMaxExecutors] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new Spark custom pool +in the specified workspace. +It supports various parameters for Spark custom pool configuration. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new Spark custom pool named "New Spark Pool" in the workspace with ID "workspace-12345" with the specified configuration. + +```powershell +New-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolName "New Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 +``` + +## PARAMETERS + +### -AutoScaleEnabled + +Specifies whether auto-scaling is enabled for the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -AutoScaleMaxNodeCount + +The maximum number of nodes for auto-scaling in the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 6 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -AutoScaleMinNodeCount + +The minimum number of nodes for auto-scaling in the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 5 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DynamicExecutorAllocationEnabled + +Specifies whether dynamic executor allocation is enabled for the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 7 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DynamicExecutorAllocationMaxExecutors + +The maximum number of executors for dynamic executor allocation in the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 9 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DynamicExecutorAllocationMinExecutors + +The minimum number of executors for dynamic executor allocation in the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 8 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NodeFamily + +The family of nodes to be used in the Spark custom pool. +This parameter is mandatory and must be 'MemoryOptimized'. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NodeSize + +The size of the nodes to be used in the Spark custom pool. +This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkCustomPoolName + +The name of the Spark custom pool to be created. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Spark custom pool will be created. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricSparkJobDefinition.md b/docs/en-US/New-FabricSparkJobDefinition.md new file mode 100644 index 00000000..02f8438a --- /dev/null +++ b/docs/en-US/New-FabricSparkJobDefinition.md @@ -0,0 +1,220 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricSparkJobDefinition +--- + +# New-FabricSparkJobDefinition + +## SYNOPSIS + +Creates a new SparkJobDefinition in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricSparkJobDefinition [-WorkspaceId] [-SparkJobDefinitionName] + [[-SparkJobDefinitionDescription] ] [[-SparkJobDefinitionPathDefinition] ] + [[-SparkJobDefinitionPathPlatformDefinition] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new SparkJobDefinition +in the specified workspace. +It supports optional parameters for SparkJobDefinition description and path definitions. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new SparkJobDefinition named "New SparkJobDefinition" in the workspace with ID "workspace-12345" with the provided description. + +```powershell +New-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionName "New SparkJobDefinition" -SparkJobDefinitionDescription "Description of the new SparkJobDefinition" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionDescription + +An optional description for the SparkJobDefinition. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionName + +The name of the SparkJobDefinition to be created. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionPathDefinition + +An optional path to the SparkJobDefinition definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionPathPlatformDefinition + +An optional path to the platform-specific definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the SparkJobDefinition will be created. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricWarehouse.md b/docs/en-US/New-FabricWarehouse.md new file mode 100644 index 00000000..de394111 --- /dev/null +++ b/docs/en-US/New-FabricWarehouse.md @@ -0,0 +1,177 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricWarehouse +--- + +# New-FabricWarehouse + +## SYNOPSIS + +Creates a new warehouse in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricWarehouse [-WorkspaceId] [-WarehouseName] + [[-WarehouseDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to create a new warehouse +in the specified workspace. +It supports optional parameters for warehouse description. + +## EXAMPLES + +### EXAMPLE 1 + +This example creates a new warehouse named "New Warehouse" in the workspace with ID "workspace-12345" with the provided description. + +```powershell +New-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseName "New Warehouse" -WarehouseDescription "Description of the new warehouse" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WarehouseDescription + +An optional description for the warehouse. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WarehouseName + +The name of the warehouse to be created. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the warehouse will be created. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricWorkspace.md b/docs/en-US/New-FabricWorkspace.md new file mode 100644 index 00000000..a1e5f908 --- /dev/null +++ b/docs/en-US/New-FabricWorkspace.md @@ -0,0 +1,177 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricWorkspace +--- + +# New-FabricWorkspace + +## SYNOPSIS + +Creates a new Fabric workspace with the specified display name. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricWorkspace [-WorkspaceName] [[-WorkspaceDescription] ] + [[-CapacityId] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `New-FabricWorkspace` function creates a new workspace in the Fabric platform by sending a POST request to the API. +It validates the display name and handles both success and error responses. + +## EXAMPLES + +### EXAMPLE 1 + +Creates a workspace named "NewWorkspace". + +```powershell +New-FabricWorkspace -WorkspaceName "NewWorkspace" +``` + +## PARAMETERS + +### -CapacityId + +(Optional) The ID of the capacity to be associated with the workspace. +This parameter is optional. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceDescription + +(Optional) A description for the workspace. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceName + +The display name of the workspace to be created. +Must only contain alphanumeric characters, spaces, and underscores. + +```yaml +Type: System.String +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/New-FabricWorkspaceUsageMetricsReport.md b/docs/en-US/New-FabricWorkspaceUsageMetricsReport.md new file mode 100644 index 00000000..c6aca360 --- /dev/null +++ b/docs/en-US/New-FabricWorkspaceUsageMetricsReport.md @@ -0,0 +1,135 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: New-FabricWorkspaceUsageMetricsReport +--- + +# New-FabricWorkspaceUsageMetricsReport + +## SYNOPSIS + +Retrieves the workspace usage metrics dataset ID. + +## SYNTAX + +### __AllParameterSets + +``` +New-FabricWorkspaceUsageMetricsReport [-WorkspaceId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +New-FabWorkspaceUsageMetricsReport + +## DESCRIPTION + +The New-FabricWorkspaceUsageMetricsReport function retrieves the workspace usage metrics dataset ID. +It supports multiple aliases for flexibility. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the workspace usage metrics dataset ID for a specific workspace given the workspace ID. + +```powershell +New-FabricWorkspaceUsageMetricsReport -workspaceId "your-workspace-id" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The ID of the workspace. +This is a mandatory parameter. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +The function retrieves the PowerBI access token and the Fabric API cluster URI. +It then makes a GET request to the Fabric API to retrieve the workspace usage metrics dataset ID, parses the response and replaces certain keys to match the expected format, and returns the 'dbName' property of the first model in the response, which is the dataset ID. + +Author: Ioana Bouariu + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Publish-FabricEnvironment.md b/docs/en-US/Publish-FabricEnvironment.md new file mode 100644 index 00000000..479de380 --- /dev/null +++ b/docs/en-US/Publish-FabricEnvironment.md @@ -0,0 +1,108 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Publish-FabricEnvironment +--- + +# Publish-FabricEnvironment + +## SYNOPSIS + +Publishes a staging environment in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Publish-FabricEnvironment [-WorkspaceId] [-EnvironmentId] [] +``` + +## ALIASES + +## DESCRIPTION + +This function interacts with the Microsoft Fabric API to initiate the publishing process for a staging environment. +It validates the authentication token, constructs the API request, and handles both immediate and long-running operations. + +## EXAMPLES + +### EXAMPLE 1 + +Initiates the publishing process for the specified staging environment. + +```powershell +Publish-FabricEnvironment -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" +``` + +## PARAMETERS + +### -EnvironmentId + +The unique identifier of the staging environment to be published. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace containing the staging environment. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. +- Uses `Confirm-TokenState` to validate the token before making API calls. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Register-FabricWorkspaceToCapacity.md b/docs/en-US/Register-FabricWorkspaceToCapacity.md new file mode 100644 index 00000000..4dc4fa7c --- /dev/null +++ b/docs/en-US/Register-FabricWorkspaceToCapacity.md @@ -0,0 +1,198 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Register-FabricWorkspaceToCapacity +--- + +# Register-FabricWorkspaceToCapacity + +## SYNOPSIS + +Sets a PowerBI workspace to a capacity. + +## SYNTAX + +### WorkspaceId + +``` +Register-FabricWorkspaceToCapacity -CapacityId [-WorkspaceId ] [-WhatIf] [-Confirm] + [] +``` + +### WorkspaceObject + +``` +Register-FabricWorkspaceToCapacity -CapacityId [-Workspace ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +Register-FabWorkspaceToCapacity + +## DESCRIPTION + +The Register-FabricWorkspaceToCapacity function Sets a PowerBI workspace to a capacity. +It supports multiple aliases for flexibility. + +## EXAMPLES + +### EXAMPLE 1 + +This example Sets the workspace with ID "Workspace-GUID" to the capacity with ID "Capacity-GUID". + +```powershell +Register-FabricWorkspaceToCapacity -WorkspaceId "Workspace-GUID" -CapacityId "Capacity-GUID" +``` + +### EXAMPLE 2 + +This example Sets the workspace object stored in the $workspace variable to the capacity with ID "Capacity-GUID". The workspace object is piped into the function. + +```powershell +$workspace | Register-FabricWorkspaceToCapacity -CapacityId "Capacity-GUID" +``` + +## PARAMETERS + +### -CapacityId + +The ID of the capacity to which the workspace will be Seted. +This is a mandatory parameter. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Workspace + +The workspace object to be Seted. +This is a mandatory parameter and can be piped into the function. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceObject + Position: Named + IsRequired: false + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The ID of the workspace to be Seted. +This is a mandatory parameter. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceId + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +{{ Fill in the Description }} + +## OUTPUTS + +## NOTES + +The function makes a POST request to the PowerBI API to Set the workspace to the capacity. +The PowerBI access token is retrieved using the Get-PowerBIAccessToken function. + +Author: Ioana Bouariu + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricCopyJob.md b/docs/en-US/Remove-FabricCopyJob.md new file mode 100644 index 00000000..aa4ed760 --- /dev/null +++ b/docs/en-US/Remove-FabricCopyJob.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricCopyJob +--- + +# Remove-FabricCopyJob + +## SYNOPSIS + +Deletes a Copy Job from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricCopyJob [-WorkspaceId] [-CopyJobId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function performs a DELETE operation on the Microsoft Fabric API to remove a Copy Job +from the specified workspace using the provided WorkspaceId and CopyJobId parameters. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the Copy Job with ID "copyjob-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "copyjob-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobId + +The unique identifier of the Copy Job to delete. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace containing the Copy Job to be deleted. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires the `$FabricConfig` global configuration, which must include `BaseUrl` and `FabricHeaders`. +- Ensures token validity by invoking `Confirm-TokenState` before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricDataPipeline.md b/docs/en-US/Remove-FabricDataPipeline.md new file mode 100644 index 00000000..7599d46e --- /dev/null +++ b/docs/en-US/Remove-FabricDataPipeline.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricDataPipeline +--- + +# Remove-FabricDataPipeline + +## SYNOPSIS + +Removes a DataPipeline from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricDataPipeline [-WorkspaceId] [-DataPipelineId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove a DataPipeline +from the specified workspace using the provided WorkspaceId and DataPipelineId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the DataPipeline with ID "pipeline-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineId "pipeline-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataPipelineId + +The unique identifier of the DataPipeline to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the DataPipeline will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricDeploymentPipeline.md b/docs/en-US/Remove-FabricDeploymentPipeline.md new file mode 100644 index 00000000..c5ab523b --- /dev/null +++ b/docs/en-US/Remove-FabricDeploymentPipeline.md @@ -0,0 +1,135 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricDeploymentPipeline +--- + +# Remove-FabricDeploymentPipeline + +## SYNOPSIS + +Deletes a specified deployment pipeline. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricDeploymentPipeline [-DeploymentPipelineId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricDeploymentPipeline` function deletes a deployment pipeline by its ID. +This operation requires admin deployment pipelines role and will fail if there's an active deployment operation. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the specified deployment pipeline. + +```powershell +Remove-FabricDeploymentPipeline -DeploymentPipelineId "GUID-GUID-GUID-GUID" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DeploymentPipelineId + +Required. +The ID of the deployment pipeline to delete. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Requires Pipeline.ReadWrite.All delegated scope. +- Requires admin deployment pipelines role. +- Operation will fail if there's an active deployment operation. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricDomain.md b/docs/en-US/Remove-FabricDomain.md new file mode 100644 index 00000000..0d20b86b --- /dev/null +++ b/docs/en-US/Remove-FabricDomain.md @@ -0,0 +1,130 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricDomain +--- + +# Remove-FabricDomain + +## SYNOPSIS + +Deletes a Fabric domain by its ID. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricDomain [-DomainId] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricDomain` function removes a specified domain from Microsoft Fabric by making a DELETE request to the relevant API endpoint. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the domain with ID "12345". + +```powershell +Remove-FabricDomain -DomainId "12345" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainId + +The unique identifier of the domain to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricDomainWorkspaceAssignment.md b/docs/en-US/Remove-FabricDomainWorkspaceAssignment.md new file mode 100644 index 00000000..b8879d85 --- /dev/null +++ b/docs/en-US/Remove-FabricDomainWorkspaceAssignment.md @@ -0,0 +1,165 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricDomainWorkspaceAssignment +--- + +# Remove-FabricDomainWorkspaceAssignment + +## SYNOPSIS + +Unassign workspaces from a specified Fabric domain. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricDomainWorkspaceAssignment [-DomainId] [[-WorkspaceIds] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +Unassign-FabricDomainWorkspace + +## DESCRIPTION + +The `Unassign -FabricDomainWorkspace` function allows you to Unassign specific workspaces from a given Fabric domain or unassign all workspaces if no workspace IDs are specified. +It makes a POST request to the relevant API endpoint for this operation. + +## EXAMPLES + +### EXAMPLE 1 + +Unassigns all workspaces from the domain with ID "12345". + +```powershell +Remove-FabricDomainWorkspaceAssignment -DomainId "12345" +``` + +### EXAMPLE 2 + +Unassigns the specified workspaces from the domain with ID "12345". + +```powershell +Remove-FabricDomainWorkspaceAssignment -DomainId "12345" -WorkspaceIds @("workspace1", "workspace2") +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainId + +The unique identifier of the Fabric domain. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceIds + +(Optional) An array of workspace IDs to unassign. +If not provided, all workspaces will be unassigned. + +```yaml +Type: System.Guid[] +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricDomainWorkspaceRoleAssignment.md b/docs/en-US/Remove-FabricDomainWorkspaceRoleAssignment.md new file mode 100644 index 00000000..a67a7a64 --- /dev/null +++ b/docs/en-US/Remove-FabricDomainWorkspaceRoleAssignment.md @@ -0,0 +1,182 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricDomainWorkspaceRoleAssignment +--- + +# Remove-FabricDomainWorkspaceRoleAssignment + +## SYNOPSIS + +Bulk unassign roles to principals for workspaces in a Fabric domain. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricDomainWorkspaceRoleAssignment [-DomainId] [-DomainRole] + [-PrincipalIds] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +Unassign-FabricDomainWorkspaceRoleAssignment + +## DESCRIPTION + +The `AssignFabricDomainWorkspaceRoleAssignment` function performs bulk role assignments for principals in a specific Fabric domain. +It sends a POST request to the relevant API endpoint. + +## EXAMPLES + +### EXAMPLE 1 + +Unassign the `Admins` role to the specified principals in the domain with ID "12345". + +```powershell +Unassign-FabricDomainWorkspaceRoleAssignment -DomainId "12345" -DomainRole "Admins" -PrincipalIds @(@{id="user1"; type="User"}, @{id="group1"; type="Group"}) +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainId + +The unique identifier of the Fabric domain where roles will be assigned. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainRole + +The role to assign to the principals. +Must be one of the following: +- `Admins` +- `Contributors` + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PrincipalIds + +An array of principals to assign roles to. +Each principal must include: +- `id`: The identifier of the principal. +- `type`: The type of the principal (e.g., `User`, `Group`). + +```yaml +Type: System.Array +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricEnvironment.md b/docs/en-US/Remove-FabricEnvironment.md new file mode 100644 index 00000000..723b3a45 --- /dev/null +++ b/docs/en-US/Remove-FabricEnvironment.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricEnvironment +--- + +# Remove-FabricEnvironment + +## SYNOPSIS + +Deletes an environment from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricEnvironment [-WorkspaceId] [-EnvironmentId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricEnvironment` function sends a DELETE request to the Fabric API to remove a specified environment from a given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the environment with ID "67890" from workspace "12345". + +```powershell +Remove-FabricEnvironment -WorkspaceId "12345" -EnvironmentId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentId + +(Mandatory) The ID of the environment to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace containing the environment to delete. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricEnvironmentStagingLibrary.md b/docs/en-US/Remove-FabricEnvironmentStagingLibrary.md new file mode 100644 index 00000000..c1419d59 --- /dev/null +++ b/docs/en-US/Remove-FabricEnvironmentStagingLibrary.md @@ -0,0 +1,174 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricEnvironmentStagingLibrary +--- + +# Remove-FabricEnvironmentStagingLibrary + +## SYNOPSIS + +Deletes a specified library from the staging environment in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricEnvironmentStagingLibrary [-WorkspaceId] [-EnvironmentId] + [-LibraryName] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function allows for the deletion of a library from the staging environment, one file at a time. +It ensures token validity, constructs the appropriate API request, and handles both success and failure responses. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the specified library from the staging environment in the specified workspace. + +```powershell +Remove-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -LibraryName "library-to-delete" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentId + +The unique identifier of the staging environment containing the library. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LibraryName + +The name of the library to be deleted from the environment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the library is to be deleted. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. +- This function currently supports deleting one library at a time. +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricEventhouse.md b/docs/en-US/Remove-FabricEventhouse.md new file mode 100644 index 00000000..f897d9f6 --- /dev/null +++ b/docs/en-US/Remove-FabricEventhouse.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricEventhouse +--- + +# Remove-FabricEventhouse + +## SYNOPSIS + +Removes an Eventhouse from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricEventhouse [-WorkspaceId] [-EventhouseId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove an Eventhouse +from the specified workspace using the provided WorkspaceId and EventhouseId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the Eventhouse with ID "eventhouse-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhouseId + +The unique identifier of the Eventhouse to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the Eventhouse will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 + +- [](https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP) diff --git a/docs/en-US/Remove-FabricEventstream.md b/docs/en-US/Remove-FabricEventstream.md new file mode 100644 index 00000000..225a14fe --- /dev/null +++ b/docs/en-US/Remove-FabricEventstream.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricEventstream +--- + +# Remove-FabricEventstream + +## SYNOPSIS + +Deletes an Eventstream from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricEventstream [-WorkspaceId] [-EventstreamId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricEventstream` function sends a DELETE request to the Fabric API to remove a specified Eventstream from a given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the Eventstream with ID "67890" from workspace "12345". + +```powershell +Remove-FabricEventstream -WorkspaceId "12345" -EventstreamId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamId + +(Mandatory) The ID of the Eventstream to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace containing the Eventstream to delete. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricItem.md b/docs/en-US/Remove-FabricItem.md new file mode 100644 index 00000000..521dc976 --- /dev/null +++ b/docs/en-US/Remove-FabricItem.md @@ -0,0 +1,184 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricItem +--- + +# Remove-FabricItem + +## SYNOPSIS + +Removes selected items from a Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricItem [-WorkspaceId] [[-filter] ] [[-itemID] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The Remove-FabricItems function removes selected items from a specified Fabric workspace. +It uses the workspace ID and an optional filter to select the items to remove. +If a filter is provided, only items whose DisplayName matches the filter are removed. + +## EXAMPLES + +### EXAMPLE 1 + +This command removes all items from the workspace with the specified ID whose DisplayName includes "test". .INPUTS String. You can pipe two strings that contain the workspace ID and filter to Remove-FabricItems. + +```powershell +Remove-FabricItem -WorkspaceID "12345678-90ab-cdef-1234-567890abcdef" -Filter "*test*" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -filter + +An optional filter to select items to remove. +If provided, only items whose DisplayName matches the filter are removed. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -itemID + +The ID of a specific item to remove. +If provided, this item is removed regardless of the filter + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The ID of the Fabric workspace. +This is a mandatory parameter. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### String. You can pipe a string that contains the workspace ID to Remove-FabricItem. + +{{ Fill in the Description }} + +## OUTPUTS + +### None. This function does not return any output. + +{{ Fill in the Description }} + +## NOTES + +Author: Rui Romano +https://github.com/microsoft/Analysis-Services/tree/master/pbidevmode/fabricps-pbip + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricKQLDashboard.md b/docs/en-US/Remove-FabricKQLDashboard.md new file mode 100644 index 00000000..89fd52fd --- /dev/null +++ b/docs/en-US/Remove-FabricKQLDashboard.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricKQLDashboard +--- + +# Remove-FabricKQLDashboard + +## SYNOPSIS + +Deletes an KQLDashboard from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricKQLDashboard [-WorkspaceId] [-KQLDashboardId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricKQLDashboard` function sends a DELETE request to the Fabric API to remove a specified KQLDashboard from a given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the KQLDashboard with ID "67890" from workspace "12345". + +```powershell +Remove-FabricKQLDashboard -WorkspaceId "12345" -KQLDashboardId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardId + +(Mandatory) The ID of the KQLDashboard to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace containing the KQLDashboard to delete. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricKQLDatabase.md b/docs/en-US/Remove-FabricKQLDatabase.md new file mode 100644 index 00000000..b8b4ec61 --- /dev/null +++ b/docs/en-US/Remove-FabricKQLDatabase.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricKQLDatabase +--- + +# Remove-FabricKQLDatabase + +## SYNOPSIS + +Deletes an KQLDatabase from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricKQLDatabase [-WorkspaceId] [-KQLDatabaseId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricKQLDatabase` function sends a DELETE request to the Fabric API to remove a specified KQLDatabase from a given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the KQLDatabase with ID "67890" from workspace "12345". + +```powershell +Remove-FabricKQLDatabase -WorkspaceId "12345" -KQLDatabaseId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseId + +(Mandatory) The ID of the KQLDatabase to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace containing the KQLDatabase to delete. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricKQLQueryset.md b/docs/en-US/Remove-FabricKQLQueryset.md new file mode 100644 index 00000000..0740d9af --- /dev/null +++ b/docs/en-US/Remove-FabricKQLQueryset.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricKQLQueryset +--- + +# Remove-FabricKQLQueryset + +## SYNOPSIS + +Deletes an KQLQueryset from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricKQLQueryset [-WorkspaceId] [-KQLQuerysetId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricKQLQueryset` function sends a DELETE request to the Fabric API to remove a specified KQLQueryset from a given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the KQLQueryset with ID "67890" from workspace "12345". + +```powershell +Remove-FabricKQLQueryset -WorkspaceId "12345" -KQLQuerysetId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetId + +(Mandatory) The ID of the KQLQueryset to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace containing the KQLQueryset to delete. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricLakehouse.md b/docs/en-US/Remove-FabricLakehouse.md new file mode 100644 index 00000000..3a30785d --- /dev/null +++ b/docs/en-US/Remove-FabricLakehouse.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricLakehouse +--- + +# Remove-FabricLakehouse + +## SYNOPSIS + +Deletes an Lakehouse from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricLakehouse [-WorkspaceId] [-LakehouseId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricLakehouse` function sends a DELETE request to the Fabric API to remove a specified Lakehouse from a given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the Lakehouse with ID "67890" from workspace "12345". + +```powershell +Remove-FabricLakehouse -WorkspaceId "12345" -LakehouseId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseId + +(Mandatory) The ID of the Lakehouse to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace containing the Lakehouse to delete. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricMLExperiment.md b/docs/en-US/Remove-FabricMLExperiment.md new file mode 100644 index 00000000..11b147fd --- /dev/null +++ b/docs/en-US/Remove-FabricMLExperiment.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricMLExperiment +--- + +# Remove-FabricMLExperiment + +## SYNOPSIS + +Removes an ML Experiment from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricMLExperiment [-WorkspaceId] [-MLExperimentId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove an ML Experiment +from the specified workspace using the provided WorkspaceId and MLExperimentId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the MLExperiment with ID "experiment-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLExperimentId + +The unique identifier of the MLExperiment to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the MLExperiment will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricMLModel.md b/docs/en-US/Remove-FabricMLModel.md new file mode 100644 index 00000000..1a679c8f --- /dev/null +++ b/docs/en-US/Remove-FabricMLModel.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricMLModel +--- + +# Remove-FabricMLModel + +## SYNOPSIS + +Removes an ML Model from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricMLModel [-WorkspaceId] [-MLModelId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove an ML Model +from the specified workspace using the provided WorkspaceId and MLModelId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the ML Model with ID "model-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLModelId + +The unique identifier of the ML Model to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the ML Model will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricMirroredDatabase.md b/docs/en-US/Remove-FabricMirroredDatabase.md new file mode 100644 index 00000000..a1365e29 --- /dev/null +++ b/docs/en-US/Remove-FabricMirroredDatabase.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricMirroredDatabase +--- + +# Remove-FabricMirroredDatabase + +## SYNOPSIS + +Deletes an MirroredDatabase from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricMirroredDatabase [-WorkspaceId] [-MirroredDatabaseId] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricMirroredDatabase` function sends a DELETE request to the Fabric API to remove a specified MirroredDatabase from a given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the MirroredDatabase with ID "67890" from workspace "12345". + +```powershell +Remove-FabricMirroredDatabase -WorkspaceId "12345" -MirroredDatabaseId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseId + +(Mandatory) The ID of the MirroredDatabase to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace containing the MirroredDatabase to delete. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricNotebook.md b/docs/en-US/Remove-FabricNotebook.md new file mode 100644 index 00000000..d5f584b6 --- /dev/null +++ b/docs/en-US/Remove-FabricNotebook.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricNotebook +--- + +# Remove-FabricNotebook + +## SYNOPSIS + +Deletes an Notebook from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricNotebook [-WorkspaceId] [-NotebookId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricNotebook` function sends a DELETE request to the Fabric API to remove a specified Notebook from a given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the Notebook with ID "67890" from workspace "12345". + +```powershell +Remove-FabricNotebook -WorkspaceId "12345" -NotebookId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookId + +(Mandatory) The ID of the Notebook to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace containing the Notebook to delete. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricRecoveryPoint.md b/docs/en-US/Remove-FabricRecoveryPoint.md new file mode 100644 index 00000000..b8c7719f --- /dev/null +++ b/docs/en-US/Remove-FabricRecoveryPoint.md @@ -0,0 +1,200 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricRecoveryPoint +--- + +# Remove-FabricRecoveryPoint + +## SYNOPSIS + +Remove a selected Fabric Recovery Point. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricRecoveryPoint [[-CreateTime] ] [[-WorkspaceGUID] ] + [[-DataWarehouseGUID] ] [[-BaseUrl] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +Remove a selected Fabric Recovery Point. + +## EXAMPLES + +### EXAMPLE 1 + +Remove a specific restore point from a Fabric Data Warehouse that has been set using Set-FabricConfig. + +```powershell +Remove-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' +``` + +### EXAMPLE 2 + +Remove a specific restore point from a Fabric Data Warehouse, specifying the workspace and data warehouse GUIDs. + +```powershell +Remove-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' +``` + +## PARAMETERS + +### -BaseUrl + +Defaults to api.powerbi.com + +```yaml +Type: System.String +DefaultValue: api.powerbi.com +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CreateTime + +The specific unique time of the restore point to remove. +Get this from Get-FabricRecoveryPoint. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataWarehouseGUID + +The GUID for the data warehouse which we want to retrieve restore points for. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceGUID + +This is the workspace GUID in which the data warehouse resides. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Jess Pomfret + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricReflex.md b/docs/en-US/Remove-FabricReflex.md new file mode 100644 index 00000000..297d9845 --- /dev/null +++ b/docs/en-US/Remove-FabricReflex.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricReflex +--- + +# Remove-FabricReflex + +## SYNOPSIS + +Removes an Reflex from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricReflex [-WorkspaceId] [-ReflexId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove an Reflex +from the specified workspace using the provided WorkspaceId and ReflexId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the Reflex with ID "Reflex-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexId + +The unique identifier of the Reflex to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the Reflex will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricReport.md b/docs/en-US/Remove-FabricReport.md new file mode 100644 index 00000000..e1fa5b0a --- /dev/null +++ b/docs/en-US/Remove-FabricReport.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricReport +--- + +# Remove-FabricReport + +## SYNOPSIS + +Removes an Report from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricReport [-WorkspaceId] [-ReportId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove an Report +from the specified workspace using the provided WorkspaceId and ReportId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the Report with ID "Report-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportId + +The unique identifier of the Report to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the Report will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricSQLDatabase.md b/docs/en-US/Remove-FabricSQLDatabase.md new file mode 100644 index 00000000..eeb66c9d --- /dev/null +++ b/docs/en-US/Remove-FabricSQLDatabase.md @@ -0,0 +1,151 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricSQLDatabase +--- + +# Remove-FabricSQLDatabase + +## SYNOPSIS + +Deletes a SQL Database from a specified workspace in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricSQLDatabase [-WorkspaceId] [-SQLDatabaseId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricSQLDatabase` function sends a DELETE request to the Fabric API to remove a specified SQLDatabase from a given workspace. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the SQL Database with ID "67890" from workspace "12345". + +```powershell +Remove-FabricSQLDatabas -WorkspaceId "12345" -SQLDatabaseId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SQLDatabaseId + +(Mandatory) The ID of the SQL Database to be deleted. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The ID of the workspace containing the SQLDatabase to delete. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Validates token expiration before making the API request. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricSemanticModel.md b/docs/en-US/Remove-FabricSemanticModel.md new file mode 100644 index 00000000..f335bfae --- /dev/null +++ b/docs/en-US/Remove-FabricSemanticModel.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricSemanticModel +--- + +# Remove-FabricSemanticModel + +## SYNOPSIS + +Removes an SemanticModel from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricSemanticModel [-WorkspaceId] [-SemanticModelId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove an SemanticModel +from the specified workspace using the provided WorkspaceId and SemanticModelId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the SemanticModel with ID "SemanticModel-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelId + +The unique identifier of the SemanticModel to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the SemanticModel will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricSparkCustomPool.md b/docs/en-US/Remove-FabricSparkCustomPool.md new file mode 100644 index 00000000..0d37c0d0 --- /dev/null +++ b/docs/en-US/Remove-FabricSparkCustomPool.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricSparkCustomPool +--- + +# Remove-FabricSparkCustomPool + +## SYNOPSIS + +Removes a Spark custom pool from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricSparkCustomPool [-WorkspaceId] [-SparkCustomPoolId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove a Spark custom pool +from the specified workspace using the provided WorkspaceId and SparkCustomPoolId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the Spark custom pool with ID "pool-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolId "pool-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkCustomPoolId + +The unique identifier of the Spark custom pool to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the Spark custom pool will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricSparkJobDefinition.md b/docs/en-US/Remove-FabricSparkJobDefinition.md new file mode 100644 index 00000000..4882a573 --- /dev/null +++ b/docs/en-US/Remove-FabricSparkJobDefinition.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricSparkJobDefinition +--- + +# Remove-FabricSparkJobDefinition + +## SYNOPSIS + +Removes an SparkJobDefinition from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricSparkJobDefinition [-WorkspaceId] [-SparkJobDefinitionId] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove an SparkJobDefinition +from the specified workspace using the provided WorkspaceId and SparkJobDefinitionId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the SparkJobDefinition with ID "SparkJobDefinition-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionId + +The unique identifier of the SparkJobDefinition to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the SparkJobDefinition will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricWarehouse.md b/docs/en-US/Remove-FabricWarehouse.md new file mode 100644 index 00000000..90cb685e --- /dev/null +++ b/docs/en-US/Remove-FabricWarehouse.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricWarehouse +--- + +# Remove-FabricWarehouse + +## SYNOPSIS + +Removes a warehouse from a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricWarehouse [-WorkspaceId] [-WarehouseId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a DELETE request to the Microsoft Fabric API to remove a warehouse +from the specified workspace using the provided WorkspaceId and WarehouseId. + +## EXAMPLES + +### EXAMPLE 1 + +This example removes the warehouse with ID "warehouse-67890" from the workspace with ID "workspace-12345". + +```powershell +Remove-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WarehouseId + +The unique identifier of the warehouse to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the warehouse will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricWorkspace.md b/docs/en-US/Remove-FabricWorkspace.md new file mode 100644 index 00000000..05c3bf0c --- /dev/null +++ b/docs/en-US/Remove-FabricWorkspace.md @@ -0,0 +1,131 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricWorkspace +--- + +# Remove-FabricWorkspace + +## SYNOPSIS + +Deletes an existing Fabric workspace by its workspace ID. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricWorkspace [-WorkspaceId] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricWorkspace` function deletes a workspace in the Fabric platform by sending a DELETE request to the API. +It validates the workspace ID and handles both success and error responses. + +## EXAMPLES + +### EXAMPLE 1 + +Deletes the workspace with the ID "workspace123". + +```powershell +Remove-FabricWorkspace -WorkspaceId "workspace123" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace to be deleted. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricWorkspaceCapacityAssignment.md b/docs/en-US/Remove-FabricWorkspaceCapacityAssignment.md new file mode 100644 index 00000000..3fc96731 --- /dev/null +++ b/docs/en-US/Remove-FabricWorkspaceCapacityAssignment.md @@ -0,0 +1,133 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricWorkspaceCapacityAssignment +--- + +# Remove-FabricWorkspaceCapacityAssignment + +## SYNOPSIS + +Unassigns a Fabric workspace from its capacity. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricWorkspaceCapacityAssignment [-WorkspaceId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +Unassign-FabricWorkspaceCapacity + +## DESCRIPTION + +The `Remove-FabricWorkspaceCapacityAssignment` function sends a POST request to unassign a workspace from its assigned capacity. + +## EXAMPLES + +### EXAMPLE 1 + +Unassign the workspace with ID "workspace123" from its capacity. + +```powershell +Remove-FabricWorkspaceCapacityAssignment -WorkspaceId "workspace123" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace to be unassigned from its capacity. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricWorkspaceFromStage.md b/docs/en-US/Remove-FabricWorkspaceFromStage.md new file mode 100644 index 00000000..cecfd81f --- /dev/null +++ b/docs/en-US/Remove-FabricWorkspaceFromStage.md @@ -0,0 +1,158 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricWorkspaceFromStage +--- + +# Remove-FabricWorkspaceFromStage + +## SYNOPSIS + +Removes a workspace from a deployment pipeline stage. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricWorkspaceFromStage [-DeploymentPipelineId] [-StageId] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricWorkspaceFromStage` function removes the workspace from the specified stage in the specified deployment pipeline. +This operation will fail if there's an active deployment operation. + +## EXAMPLES + +### EXAMPLE 1 + +Removes the workspace from the specified deployment pipeline stage. + +```powershell +Remove-FabricWorkspaceFromStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DeploymentPipelineId + +Required. +The ID of the deployment pipeline. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -StageId + +Required. +The ID of the deployment pipeline stage. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Requires Pipeline.ReadWrite.All delegated scope. +- Requires admin deployment pipelines role. +- This operation will fail if there's an active deployment operation. +- This API is in preview. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Remove-FabricWorkspaceIdentity.md b/docs/en-US/Remove-FabricWorkspaceIdentity.md new file mode 100644 index 00000000..7cb921a0 --- /dev/null +++ b/docs/en-US/Remove-FabricWorkspaceIdentity.md @@ -0,0 +1,130 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricWorkspaceIdentity +--- + +# Remove-FabricWorkspaceIdentity + +## SYNOPSIS + +Deprovisions the Managed Identity for a specified Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricWorkspaceIdentity [-WorkspaceId] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricWorkspaceCapacity` function deprovisions the Managed Identity from the given workspace by calling the appropriate API endpoint. + +## EXAMPLES + +### EXAMPLE 1 + +Deprovisions the Managed Identity for the workspace with ID "workspace123". + +```powershell +Remove-FabricWorkspaceCapacity -WorkspaceId "workspace123" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace from which the identity will be removed. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Remove-FabricWorkspaceRoleAssignment.md b/docs/en-US/Remove-FabricWorkspaceRoleAssignment.md new file mode 100644 index 00000000..d27e2013 --- /dev/null +++ b/docs/en-US/Remove-FabricWorkspaceRoleAssignment.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Remove-FabricWorkspaceRoleAssignment +--- + +# Remove-FabricWorkspaceRoleAssignment + +## SYNOPSIS + +Removes a role assignment from a Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Remove-FabricWorkspaceRoleAssignment [-WorkspaceId] [-WorkspaceRoleAssignmentId] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Remove-FabricWorkspaceRoleAssignment` function deletes a specific role assignment from a Fabric workspace by making a DELETE request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Removes the role assignment with the ID "role123" from the workspace "workspace123". + +```powershell +Remove-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "role123" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceRoleAssignmentId + +The unique identifier of the role assignment to be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Restore-FabricRecoveryPoint.md b/docs/en-US/Restore-FabricRecoveryPoint.md new file mode 100644 index 00000000..ea1108b0 --- /dev/null +++ b/docs/en-US/Restore-FabricRecoveryPoint.md @@ -0,0 +1,222 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Restore-FabricRecoveryPoint +--- + +# Restore-FabricRecoveryPoint + +## SYNOPSIS + +Restore a Fabric data warehouse to a specified restore pont. + +## SYNTAX + +### __AllParameterSets + +``` +Restore-FabricRecoveryPoint [[-CreateTime] ] [[-WorkspaceGUID] ] + [[-DataWarehouseGUID] ] [[-BaseUrl] ] [-Wait] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +Restore a Fabric data warehouse to a specified restore pont. + +## EXAMPLES + +### EXAMPLE 1 + +Restore a Fabric Data Warehouse to a specific restore point that has been set using Set-FabricConfig. + +```powershell +Restore-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' +``` + +### EXAMPLE 2 + +Restore a Fabric Data Warehouse to a specific restore point, specifying the workspace and data warehouse GUIDs. + +```powershell +Restore-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' +``` + +## PARAMETERS + +### -BaseUrl + +Defaults to api.powerbi.com + +```yaml +Type: System.String +DefaultValue: api.powerbi.com +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CreateTime + +The specific unique time of the restore point to remove. +Get this from Get-FabricRecoveryPoint. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataWarehouseGUID + +The GUID for the data warehouse which we want to retrieve restore points for. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Wait + +Wait for the restore to complete before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceGUID + +This is the workspace GUID in which the data warehouse resides. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Jess Pomfret + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Resume-FabricCapacity.md b/docs/en-US/Resume-FabricCapacity.md new file mode 100644 index 00000000..19ab1463 --- /dev/null +++ b/docs/en-US/Resume-FabricCapacity.md @@ -0,0 +1,185 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Resume-FabricCapacity +--- + +# Resume-FabricCapacity + +## SYNOPSIS + +Resumes a capacity. + +## SYNTAX + +### __AllParameterSets + +``` +Resume-FabricCapacity [-subscriptionID] [-resourcegroup] [-capacity] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +Resume-FabCapacity + +## DESCRIPTION + +The Resume-FabricCapacity function resumes a capacity. +It supports multiple aliases for flexibility. + +## EXAMPLES + +### EXAMPLE 1 + +This example resumes a capacity given the subscription ID, resource group, and capacity. + +```powershell +Resume-FabricCapacity -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" +``` + +## PARAMETERS + +### -capacity + +The capacity. +This is a mandatory parameter. +This is a parameter found in Azure, not Fabric. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -resourcegroup + +The resource group. +This is a mandatory parameter. +This is a parameter found in Azure, not Fabric. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -subscriptionID + +The the ID of the subscription. +This is a mandatory parameter. +This is a parameter found in Azure, not Fabric. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +The function defines parameters for the subscription ID, resource group, and capacity. +If the 'azToken' environment variable is null, it connects to the Azure account and sets the 'azToken' environment variable. +It then defines the headers for the request, defines the URI for the request, and makes a GET request to the URI. + +Author: Ioana Bouariu + +Define aliases for the function for flexibility. + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Revoke-FabricCapacityTenantSettingOverrides.md b/docs/en-US/Revoke-FabricCapacityTenantSettingOverrides.md new file mode 100644 index 00000000..f8860de5 --- /dev/null +++ b/docs/en-US/Revoke-FabricCapacityTenantSettingOverrides.md @@ -0,0 +1,152 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Revoke-FabricCapacityTenantSettingOverrides +--- + +# Revoke-FabricCapacityTenantSettingOverrides + +## SYNOPSIS + +Removes a tenant setting override from a specific capacity in the Fabric tenant. + +## SYNTAX + +### __AllParameterSets + +``` +Revoke-FabricCapacityTenantSettingOverrides [-CapacityId] [-tenantSettingName] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Revoke-FabricCapacityTenantSettingOverrides` function deletes a specific tenant setting override for a given capacity in the Fabric tenant by making a DELETE request to the appropriate API endpoint. + +## EXAMPLES + +### EXAMPLE 1 + +Removes the tenant setting override named "ExampleSetting" from the capacity with ID "12345". + +```powershell +Revoke-FabricCapacityTenantSettingOverrides -capacityId "12345" -tenantSettingName "ExampleSetting" +``` + +## PARAMETERS + +### -CapacityId + +The unique identifier of the capacity from which the tenant setting override will be removed. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -tenantSettingName + +The name of the tenant setting override to be removed. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Revoke-FabricExternalDataShares.md b/docs/en-US/Revoke-FabricExternalDataShares.md new file mode 100644 index 00000000..8a43e7c2 --- /dev/null +++ b/docs/en-US/Revoke-FabricExternalDataShares.md @@ -0,0 +1,174 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Revoke-FabricExternalDataShares +--- + +# Revoke-FabricExternalDataShares + +## SYNOPSIS + +Retrieves External Data Shares details from a specified Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Revoke-FabricExternalDataShares [-WorkspaceId] [-ItemId] [-ExternalDataShareId] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function retrieves External Data Shares details. +It handles token validation, constructs the API URL, makes the API request, and processes the response. + +## EXAMPLES + +### EXAMPLE 1 + +This example retrieves the External Data Shares details + +```powershell +Get-FabricExternalDataShares +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ExternalDataShareId + +The unique identifier of the External Data Share to be retrieved. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ItemId + +The unique identifier of the item associated with the External Data Shares. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the External Data Shares resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Set-FabricConfig.md b/docs/en-US/Set-FabricConfig.md new file mode 100644 index 00000000..911b3b3d --- /dev/null +++ b/docs/en-US/Set-FabricConfig.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Set-FabricConfig +--- + +# Set-FabricConfig + +## SYNOPSIS + +Register the configuration for use with all functions in the PSFabricTools module. + +## SYNTAX + +### __AllParameterSets + +``` +Set-FabricConfig [[-WorkspaceGUID] ] [[-DataWarehouseGUID] ] [[-BaseUrl] ] + [-SkipPersist] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +Register the configuration for use with all functions in the PSFabricTools module. + +## EXAMPLES + +### EXAMPLE 1 + +Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module. + +```powershell +Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' +``` + +### EXAMPLE 2 + +Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module, but does not persist the values. + +```powershell +Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -SkipPersist +``` + +## PARAMETERS + +### -BaseUrl + +Defaults to api.powerbi.com + +```yaml +Type: System.Object +DefaultValue: api.powerbi.com +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataWarehouseGUID + +The GUID for the Data Warehouse which we want to retrieve restore points for. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SkipPersist + +If set, the configuration will not be persisted to the registry. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceGUID + +This is the workspace GUID in which the Data Warehouse resides. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Jess Pomfret + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Start-FabricDeploymentPipelineStage.md b/docs/en-US/Start-FabricDeploymentPipelineStage.md new file mode 100644 index 00000000..12f96de8 --- /dev/null +++ b/docs/en-US/Start-FabricDeploymentPipelineStage.md @@ -0,0 +1,277 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Start-FabricDeploymentPipelineStage +--- + +# Start-FabricDeploymentPipelineStage + +## SYNOPSIS + +Deploys items from one stage to another in a deployment pipeline. + +## SYNTAX + +### __AllParameterSets + +``` +Start-FabricDeploymentPipelineStage [-DeploymentPipelineId] [-SourceStageId] + [-TargetStageId] [[-Items] ] [[-Note] ] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Start-FabricDeploymentPipelineStage` function deploys items from the specified source stage to the target stage. +This API supports long running operations (LRO) and will return an operation ID that can be used to track the deployment status. + +## EXAMPLES + +### EXAMPLE 1 + +Deploys all supported items from the source stage to the target stage. + +```powershell +$params = @{ + DeploymentPipelineId = "GUID-GUID-GUID-GUID" + SourceStageId = "GUID-GUID-GUID-GUID" + TargetStageId = "GUID-GUID-GUID-GUID" + Note = "Deploying business ready items" +} +Start-FabricDeploymentPipelineStage @params +``` + +### EXAMPLE 2 + +Deploys specific items from the source stage to the target stage. + +```powershell +$items = @( + @{ + sourceItemId = "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b" + itemType = "Datamart" + }, + @{ + sourceItemId = "1a201f2a-d1d8-45c0-8c61-1676338517de" + itemType = "SemanticModel" + } +) +Start-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -SourceStageId "GUID-GUID-GUID-GUID" -TargetStageId "GUID-GUID-GUID-GUID" -Items $items -Note "Deploying specific items" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DeploymentPipelineId + +Required. +The ID of the deployment pipeline. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Items + +Optional. +A list of items to be deployed. +If not specified, all supported stage items are deployed. +Each item should be a hashtable with: +- sourceItemId: The ID of the item to deploy +- itemType: The type of the item (e.g., "Report", "Dashboard", "Datamart", "SemanticModel") + +```yaml +Type: System.Array +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Note + +Optional. +A note describing the deployment. +Limited to 1024 characters. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NoWait + +Optional. +If specified, the function will not wait for the deployment to complete and will return immediately. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SourceStageId + +Required. +The ID of the source stage to deploy from. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TargetStageId + +Required. +The ID of the target stage to deploy to. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- Requires Pipeline.Deploy delegated scope. +- Requires admin deployment pipelines role. +- Requires contributor or higher role on both source and target workspaces. +- Maximum 300 deployed items per request. +- This API is in preview. + +Author: Kamil Nowinski + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Start-FabricLakehouseTableMaintenance.md b/docs/en-US/Start-FabricLakehouseTableMaintenance.md new file mode 100644 index 00000000..4b7f1426 --- /dev/null +++ b/docs/en-US/Start-FabricLakehouseTableMaintenance.md @@ -0,0 +1,327 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Start-FabricLakehouseTableMaintenance +--- + +# Start-FabricLakehouseTableMaintenance + +## SYNOPSIS + +Initiates a table maintenance job for a specified Lakehouse in a Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Start-FabricLakehouseTableMaintenance [-WorkspaceId] [-LakehouseId] + [[-JobType] ] [[-SchemaName] ] [[-TableName] ] [[-IsVOrder] ] + [[-ColumnsZOrderBy] ] [[-retentionPeriod] ] [[-waitForCompletion] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Fabric API to start a table maintenance job for a specified Lakehouse. +It allows for optional parameters such as schema name, table name, and Z-ordering columns. +The function also handles asynchronous operations and can wait for completion if specified. + +## EXAMPLES + +### EXAMPLE 1 + +Initiates a table maintenance job for the specified Lakehouse and waits for its completion. + +```powershell +Start-FabricLakehouseTableMaintenance -WorkspaceId "12345" -LakehouseId "67890" -JobType "TableMaintenance" -SchemaName "dbo" -TableName "MyTable" -IsVOrder $true -ColumnsZOrderBy @("Column1", "Column2") -retentionPeriod "7:00:00" -waitForCompletion $true +``` + +### EXAMPLE 2 + +Initiates a table maintenance job for the specified Lakehouse without waiting for its completion. + +```powershell +Start-FabricLakehouseTableMaintenance -WorkspaceId "12345" -LakehouseId "67890" -JobType "TableMaintenance" -SchemaName "dbo" -TableName "MyTable" -IsVOrder $false -ColumnsZOrderBy @("Column1", "Column2") -retentionPeriod "7:00:00" +``` + +## PARAMETERS + +### -ColumnsZOrderBy + +An array of columns to be used for Z-ordering. +This parameter is optional. + +```yaml +Type: System.Array +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 6 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -IsVOrder + +A boolean flag indicating whether to apply V-ordering. +This parameter is optional. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 5 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -JobType + +The type of job to be initiated. +Default is "TableMaintenance". +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: TableMaintenance +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseId + +The unique identifier of the Lakehouse for which the table maintenance job is to be initiated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -retentionPeriod + +The retention period for the table maintenance job. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 7 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SchemaName + +The name of the schema in the Lakehouse. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TableName + +The name of the table in the Lakehouse. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -waitForCompletion + +A boolean flag indicating whether to wait for the job to complete. +Default is false. +This parameter is optional. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 8 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Lakehouse resides. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- This function handles asynchronous operations and retrieves operation results if required. +- The function uses the `Write-Message` function for logging and debugging purposes. +- The function uses the `Get-FabricLakehouse` function to retrieve Lakehouse details. +- The function uses the `Get-FabricLongRunningOperation` function to check the status of long-running operations. +- The function uses the `Invoke-RestMethod` cmdlet to make API requests. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Start-FabricMirroredDatabaseMirroring.md b/docs/en-US/Start-FabricMirroredDatabaseMirroring.md new file mode 100644 index 00000000..27594167 --- /dev/null +++ b/docs/en-US/Start-FabricMirroredDatabaseMirroring.md @@ -0,0 +1,156 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Start-FabricMirroredDatabaseMirroring +--- + +# Start-FabricMirroredDatabaseMirroring + +## SYNOPSIS + +Starts the mirroring of a specified mirrored database in a given workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Start-FabricMirroredDatabaseMirroring [-WorkspaceId] [[-MirroredDatabaseId] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to start the mirroring of a specified mirrored database. +It requires the workspace ID and the mirrored database ID as parameters. + +## EXAMPLES + +### EXAMPLE 1 + +Starts the mirroring of the mirrored database with ID `67890` in the workspace `12345`. + +```powershell +Start-FabricMirroredDatabaseMirroring -WorkspaceId "12345" -MirroredDatabaseId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseId + +The unique identifier of the mirrored database to be started. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the mirrored database resides. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- This function handles asynchronous operations and retrieves operation results if required. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Start-FabricSparkJobDefinitionOnDemand.md b/docs/en-US/Start-FabricSparkJobDefinitionOnDemand.md new file mode 100644 index 00000000..2b543c56 --- /dev/null +++ b/docs/en-US/Start-FabricSparkJobDefinitionOnDemand.md @@ -0,0 +1,200 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Start-FabricSparkJobDefinitionOnDemand +--- + +# Start-FabricSparkJobDefinitionOnDemand + +## SYNOPSIS + +Starts a Fabric Spark Job Definition on demand. + +## SYNTAX + +### __AllParameterSets + +``` +Start-FabricSparkJobDefinitionOnDemand [-WorkspaceId] [-SparkJobDefinitionId] + [[-JobType] ] [[-waitForCompletion] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function initiates a Spark Job Definition on demand within a specified workspace. +It constructs the appropriate API endpoint URL and makes a POST request to start the job. +The function can optionally wait for the job to complete based on the 'waitForCompletion' parameter. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Start-FabricSparkJobDefinitionOnDemand -WorkspaceId "workspace123" -SparkJobDefinitionId "jobdef456" -waitForCompletion $true +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -JobType + +The type of job to be started. +The default value is 'sparkjob'. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: sparkjob +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionId + +The ID of the Spark Job Definition to be started. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -waitForCompletion + +A boolean flag indicating whether to wait for the job to complete. +The default value is $false. +This parameter is optional. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The ID of the workspace where the Spark Job Definition is located. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Ensure that the necessary authentication tokens are valid before running this function. +The function logs detailed messages for debugging and informational purposes. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Stop-FabricEnvironmentPublish.md b/docs/en-US/Stop-FabricEnvironmentPublish.md new file mode 100644 index 00000000..15cf0e7a --- /dev/null +++ b/docs/en-US/Stop-FabricEnvironmentPublish.md @@ -0,0 +1,153 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Stop-FabricEnvironmentPublish +--- + +# Stop-FabricEnvironmentPublish + +## SYNOPSIS + +Cancels the publish operation for a specified environment in Microsoft Fabric. + +## SYNTAX + +### __AllParameterSets + +``` +Stop-FabricEnvironmentPublish [-WorkspaceId] [-EnvironmentId] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a cancel publish request to the Microsoft Fabric API for a given environment. +It ensures that the token is valid before making the request and handles both successful and error responses. + +## EXAMPLES + +### EXAMPLE 1 + +Cancels the publish operation for the specified environment. + +```powershell +Stop-FabricEnvironmentPublish -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentId + +The unique identifier of the environment for which the publish operation is to be canceled. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the environment exists. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Validates token expiration before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Stop-FabricMirroredDatabaseMirroring.md b/docs/en-US/Stop-FabricMirroredDatabaseMirroring.md new file mode 100644 index 00000000..d1b9f77f --- /dev/null +++ b/docs/en-US/Stop-FabricMirroredDatabaseMirroring.md @@ -0,0 +1,156 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Stop-FabricMirroredDatabaseMirroring +--- + +# Stop-FabricMirroredDatabaseMirroring + +## SYNOPSIS + +Stops the mirroring of a specified mirrored database in a given workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Stop-FabricMirroredDatabaseMirroring [-WorkspaceId] [[-MirroredDatabaseId] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a POST request to the Microsoft Fabric API to stop the mirroring of a specified mirrored database. +It requires the workspace ID and the mirrored database ID as parameters. + +## EXAMPLES + +### EXAMPLE 1 + +Stops the mirroring of the mirrored database with ID `67890` in the workspace `12345`. + +```powershell +Stop-FabricMirroredDatabaseMirroring -WorkspaceId "12345" -MirroredDatabaseId "67890" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseId + +The unique identifier of the mirrored database to be stopped. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the mirrored database resides. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- This function handles asynchronous operations and retrieves operation results if required. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Suspend-FabricCapacity.md b/docs/en-US/Suspend-FabricCapacity.md new file mode 100644 index 00000000..fc3ed17f --- /dev/null +++ b/docs/en-US/Suspend-FabricCapacity.md @@ -0,0 +1,186 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Suspend-FabricCapacity +--- + +# Suspend-FabricCapacity + +## SYNOPSIS + +Suspends a capacity. + +## SYNTAX + +### __AllParameterSets + +``` +Suspend-FabricCapacity [-subscriptionID] [-resourcegroup] [-capacity] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +Suspend-FabCapacity Suspend-PowerBICapacity + +## DESCRIPTION + +The Suspend-FabricCapacity function suspends a capacity. +It supports multiple aliases for flexibility. + +## EXAMPLES + +### EXAMPLE 1 + +This example suspends a capacity given the subscription ID, resource group, and capacity. + +```powershell +Suspend-FabricCapacity -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" +``` + +## PARAMETERS + +### -capacity + +The the capacity. +This is a mandatory parameter. +This is a parameter found in Azure, not Fabric. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -resourcegroup + +The resource group. +This is a mandatory parameter. +This is a parameter found in Azure, not Fabric. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -subscriptionID + +The ID of the subscription. +This is a mandatory parameter. +This is a parameter found in Azure, not Fabric. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +The function defines parameters for the subscription ID, resource group, and capacity. +If the 'azToken' environment variable is null, it connects to the Azure account and sets the 'azToken' environment variable. +It then defines the headers for the request, defines the URI for the request, and makes a GET request to the URI. + +Author: Ioana Bouariu + + + Define aliases for the function for flexibility. + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Unregister-FabricWorkspaceToCapacity.md b/docs/en-US/Unregister-FabricWorkspaceToCapacity.md new file mode 100644 index 00000000..7209375d --- /dev/null +++ b/docs/en-US/Unregister-FabricWorkspaceToCapacity.md @@ -0,0 +1,176 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Unregister-FabricWorkspaceToCapacity +--- + +# Unregister-FabricWorkspaceToCapacity + +## SYNOPSIS + +Unregisters a workspace from a capacity. + +## SYNTAX + +### WorkspaceId + +``` +Unregister-FabricWorkspaceToCapacity -WorkspaceId [-WhatIf] [-Confirm] [] +``` + +### WorkspaceObject + +``` +Unregister-FabricWorkspaceToCapacity -Workspace [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +Unregister-FabWorkspaceToCapacity + +## DESCRIPTION + +The Unregister-FabricWorkspaceToCapacity function unregisters a workspace from a capacity in PowerBI. +It can be used to remove a workspace from a capacity, allowing it to be assigned to a different capacity or remain unassigned. + +## EXAMPLES + +### EXAMPLE 1 + +Unregisters the workspace with ID "12345678" from the capacity. + +```powershell +Unregister-FabricWorkspaceToCapacity -WorkspaceId "12345678" +``` + +### EXAMPLE 2 + +Unregisters the workspace objects piped from Get-FabricWorkspace from the capacity. .INPUTS System.Management.Automation.PSCustomObject + +```powershell +Get-FabricWorkspace | Unregister-FabricWorkspaceToCapacity +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Workspace + +Specifies the workspace object to be unregistered from the capacity. +This parameter is mandatory when using the 'WorkspaceObject' parameter set. +The workspace object can be piped into the function. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceObject + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +Specifies the ID of the workspace to be unregistered from the capacity. +This parameter is mandatory when using the 'WorkspaceId' parameter set. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: WorkspaceId + Position: Named + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +{{ Fill in the Description }} + +## OUTPUTS + +### System.Object + +{{ Fill in the Description }} + +## NOTES + +Author: Ioana Bouariu + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Update-FabricCapacityTenantSettingOverrides.md b/docs/en-US/Update-FabricCapacityTenantSettingOverrides.md new file mode 100644 index 00000000..eb7a96a9 --- /dev/null +++ b/docs/en-US/Update-FabricCapacityTenantSettingOverrides.md @@ -0,0 +1,290 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricCapacityTenantSettingOverrides +--- + +# Update-FabricCapacityTenantSettingOverrides + +## SYNOPSIS + +Updates tenant setting overrides for a specified capacity ID. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricCapacityTenantSettingOverrides [-TenantSettingName] + [-EnableTenantSetting] [[-DelegateToCapacity] ] [[-DelegateToDomain] ] + [[-DelegateToWorkspace] ] [[-EnabledSecurityGroups] ] + [[-ExcludedSecurityGroups] ] [[-Properties] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricCapacityTenantSettingOverrides` function updates tenant setting overrides in a Fabric environment by making a POST request to the appropriate API endpoint. +It allows specifying settings such as enabling tenant settings, delegating to a workspace, and including or excluding security groups. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the tenant setting "SomeSetting" for the capacity with ID "12345" and enables it. + +```powershell +Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" +``` + +### EXAMPLE 2 + +Updates the tenant setting "SomeSetting" for the capacity with ID "12345", enables it, and specifies security groups to include. + +```powershell +Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" -EnabledSecurityGroups @(@{graphId="1";name="Group1"},@{graphId="2";name="Group2"}) +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DelegateToCapacity + +{{ Fill DelegateToCapacity Description }} + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DelegateToDomain + +{{ Fill DelegateToDomain Description }} + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DelegateToWorkspace + +(Optional) Specifies the workspace to which the setting should be delegated. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnabledSecurityGroups + +(Optional) A JSON array of security groups to be enabled, each containing `graphId` and `name` properties. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 5 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnableTenantSetting + +(Mandatory) Indicates whether the tenant setting should be enabled. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ExcludedSecurityGroups + +(Optional) A JSON array of security groups to be excluded, each containing `graphId` and `name` properties. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 6 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Properties + +{{ Fill Properties Description }} + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 7 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TenantSettingName + +{{ Fill TenantSettingName Description }} + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricCopyJob.md b/docs/en-US/Update-FabricCopyJob.md new file mode 100644 index 00000000..aa52d649 --- /dev/null +++ b/docs/en-US/Update-FabricCopyJob.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricCopyJob +--- + +# Update-FabricCopyJob + +## SYNOPSIS + +Updates an existing Copy Job in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricCopyJob [-WorkspaceId] [-CopyJobId] [-CopyJobName] + [[-CopyJobDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +Sends a PATCH request to the Microsoft Fabric API to update an existing Copy Job +in the specified workspace. +Allows updating the Copy Job's name and optionally its description. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the Copy Job with ID "copyjob-67890" in the workspace "workspace-12345" with a new name and description. + +```powershell +Update-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "copyjob-67890" -CopyJobName "Updated Copy Job" -CopyJobDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobDescription + +An optional new description for the Copy Job. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobId + +The unique identifier of the Copy Job to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobName + +The new name for the Copy Job. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace containing the Copy Job. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires the `$FabricConfig` global configuration, which includes `BaseUrl` and `FabricHeaders`. +- Ensures token validity by calling `Confirm-TokenState` before making the API request. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Update-FabricCopyJobDefinition.md b/docs/en-US/Update-FabricCopyJobDefinition.md new file mode 100644 index 00000000..2db55afc --- /dev/null +++ b/docs/en-US/Update-FabricCopyJobDefinition.md @@ -0,0 +1,208 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricCopyJobDefinition +--- + +# Update-FabricCopyJobDefinition + +## SYNOPSIS + +Updates the definition of a Copy Job in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricCopyJobDefinition [-WorkspaceId] [-CopyJobId] + [-CopyJobPathDefinition] [[-CopyJobPathPlatformDefinition] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function updates the content or metadata of a Copy Job within a Microsoft Fabric workspace. +The Copy Job content and platform-specific definitions can be provided as file paths, which will be encoded as Base64 and sent in the request. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the content of the Copy Job with ID `67890` in the workspace `12345` using the specified Copy Job file. + +```powershell +Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb" +``` + +### EXAMPLE 2 + +Updates both the content and platform-specific definition of the Copy Job with ID `67890` in the workspace `12345`. + +```powershell +Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb" -CopyJobPathPlatformDefinition "C:\CopyJobs\Platform.json" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobId + +(Mandatory) The unique identifier of the Copy Job to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobPathDefinition + +(Mandatory) The file path to the Copy Job content definition file. +The file content will be encoded as Base64. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CopyJobPathPlatformDefinition + +(Optional) The file path to the platform-specific definition file for the Copy Job. +The file content will be encoded as Base64. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace containing the Copy Job. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires the `$FabricConfig` global configuration, which must include `BaseUrl` and `FabricHeaders`. +- Validates token expiration using `Confirm-TokenState` before making the API request. +- Encodes file content as Base64 before sending it to the Fabric API. +- Logs detailed messages for debugging and error handling. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Update-FabricDataPipeline.md b/docs/en-US/Update-FabricDataPipeline.md new file mode 100644 index 00000000..b541fa19 --- /dev/null +++ b/docs/en-US/Update-FabricDataPipeline.md @@ -0,0 +1,200 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricDataPipeline +--- + +# Update-FabricDataPipeline + +## SYNOPSIS + +Updates an existing DataPipeline in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricDataPipeline [-WorkspaceId] [-DataPipelineId] + [-DataPipelineName] [[-DataPipelineDescription] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing DataPipeline +in the specified workspace. +It supports optional parameters for DataPipeline description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the DataPipeline with ID "pipeline-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineId "pipeline-67890" -DataPipelineName "Updated DataPipeline" -DataPipelineDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataPipelineDescription + +An optional new description for the DataPipeline. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataPipelineId + +The unique identifier of the DataPipeline to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DataPipelineName + +The new name of the DataPipeline. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the DataPipeline exists. +This parameter is optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricDomain.md b/docs/en-US/Update-FabricDomain.md new file mode 100644 index 00000000..400ece92 --- /dev/null +++ b/docs/en-US/Update-FabricDomain.md @@ -0,0 +1,196 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricDomain +--- + +# Update-FabricDomain + +## SYNOPSIS + +Updates a Fabric domain by its ID. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricDomain [-DomainId] [-DomainName] [[-DomainDescription] ] + [[-DomainContributorsScope] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricDomain` function modifies a specified domain in Microsoft Fabric using the provided parameters. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the domain with ID "12345" with a new name, description, and contributors' scope. + +```powershell +Update-FabricDomain -DomainId "12345" -DomainName "NewDomain" -DomainDescription "Updated description" -DomainContributorsScope "AdminsOnly" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainContributorsScope + +(Optional) The contributors' scope for the domain. +Accepted values: 'AdminsOnly', 'AllTenant', 'SpecificUsersAndGroups'. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainDescription + +(Optional) A new description for the domain. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainId + +The unique identifier of the domain to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DomainName + +The new name for the domain. +Must be alphanumeric. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricEnvironment.md b/docs/en-US/Update-FabricEnvironment.md new file mode 100644 index 00000000..a5de8b60 --- /dev/null +++ b/docs/en-US/Update-FabricEnvironment.md @@ -0,0 +1,202 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricEnvironment +--- + +# Update-FabricEnvironment + +## SYNOPSIS + +Updates the properties of a Fabric Environment. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricEnvironment [-WorkspaceId] [-EnvironmentId] [-EnvironmentName] + [[-EnvironmentDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricEnvironment` function updates the name and/or description of a specified Fabric Environment by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the name of the Environment with the ID "Environment123" to "NewEnvironmentName". + +```powershell +Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewEnvironmentName" +``` + +### EXAMPLE 2 + +Updates both the name and description of the Environment "Environment123". + +```powershell +Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewName" -EnvironmentDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentDescription + +(Optional) The new description for the Environment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentId + +The unique identifier of the Environment to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentName + +The new name for the Environment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Environment resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricEnvironmentStagingSparkCompute.md b/docs/en-US/Update-FabricEnvironmentStagingSparkCompute.md new file mode 100644 index 00000000..706689d7 --- /dev/null +++ b/docs/en-US/Update-FabricEnvironmentStagingSparkCompute.md @@ -0,0 +1,386 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricEnvironmentStagingSparkCompute +--- + +# Update-FabricEnvironmentStagingSparkCompute + +## SYNOPSIS + +Updates the Spark compute configuration in the staging environment for a given workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricEnvironmentStagingSparkCompute [-WorkspaceId] [-EnvironmentId] + [-InstancePoolName] [-InstancePoolType] [-DriverCores] + [-DriverMemory] [-ExecutorCores] [-ExecutorMemory] + [-DynamicExecutorAllocationEnabled] [-DynamicExecutorAllocationMinExecutors] + [-DynamicExecutorAllocationMaxExecutors] [-RuntimeVersion] + [-SparkProperties] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update the Spark compute settings +for a specified environment, including instance pool, driver and executor configurations, and dynamic allocation settings. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Update-FabricEnvironmentStagingSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "env-67890" -InstancePoolName "pool1" -InstancePoolType "Workspace" -DriverCores 4 -DriverMemory "16GB" -ExecutorCores 8 -ExecutorMemory "32GB" -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 2 -DynamicExecutorAllocationMaxExecutors 10 -RuntimeVersion "3.1" -SparkProperties @{ "spark.executor.memoryOverhead"="4GB" } +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DriverCores + +The number of cores to allocate to the driver. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DriverMemory + +The amount of memory to allocate to the driver. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 5 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DynamicExecutorAllocationEnabled + +Boolean flag to enable or disable dynamic executor allocation. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 8 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DynamicExecutorAllocationMaxExecutors + +The maximum number of executors when dynamic allocation is enabled. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 10 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DynamicExecutorAllocationMinExecutors + +The minimum number of executors when dynamic allocation is enabled. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 9 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentId + +The unique identifier of the environment where the Spark compute settings will be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ExecutorCores + +The number of cores to allocate to each executor. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 6 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ExecutorMemory + +The amount of memory to allocate to each executor. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 7 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -InstancePoolName + +The name of the instance pool to be used for Spark compute. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -InstancePoolType + +The type of instance pool (either 'Workspace' or 'Capacity'). + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -RuntimeVersion + +The Spark runtime version to use. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 11 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkProperties + +A hashtable of additional Spark properties to configure. + +```yaml +Type: System.Object +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 12 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the environment exists. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricEventhouse.md b/docs/en-US/Update-FabricEventhouse.md new file mode 100644 index 00000000..b6a11748 --- /dev/null +++ b/docs/en-US/Update-FabricEventhouse.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricEventhouse +--- + +# Update-FabricEventhouse + +## SYNOPSIS + +Updates an existing Eventhouse in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricEventhouse [-WorkspaceId] [-EventhouseId] [-EventhouseName] + [[-EventhouseDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing Eventhouse +in the specified workspace. +It supports optional parameters for Eventhouse description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhouseName "Updated Eventhouse" -EventhouseDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhouseDescription + +An optional new description for the Eventhouse. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhouseId + +The unique identifier of the Eventhouse to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhouseName + +The new name of the Eventhouse. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Eventhouse exists. +This parameter is optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricEventhouseDefinition.md b/docs/en-US/Update-FabricEventhouseDefinition.md new file mode 100644 index 00000000..9f18af6b --- /dev/null +++ b/docs/en-US/Update-FabricEventhouseDefinition.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricEventhouseDefinition +--- + +# Update-FabricEventhouseDefinition + +## SYNOPSIS + +Updates the definition of an existing Eventhouse in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricEventhouseDefinition [-WorkspaceId] [-EventhouseId] + [-EventhousePathDefinition] [[-EventhousePathPlatformDefinition] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Eventhouse +in the specified workspace. +It supports optional parameters for Eventhouse definition and platform-specific definition. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" using the provided definition file. + +```powershell +Update-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhousePathDefinition "C:\Path\To\EventhouseDefinition.json" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhouseId + +The unique identifier of the Eventhouse to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhousePathDefinition + +An optional path to the Eventhouse definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventhousePathPlatformDefinition + +An optional path to the platform-specific definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Eventhouse exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricEventstream.md b/docs/en-US/Update-FabricEventstream.md new file mode 100644 index 00000000..ba2df999 --- /dev/null +++ b/docs/en-US/Update-FabricEventstream.md @@ -0,0 +1,202 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricEventstream +--- + +# Update-FabricEventstream + +## SYNOPSIS + +Updates the properties of a Fabric Eventstream. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricEventstream [-WorkspaceId] [-EventstreamId] [-EventstreamName] + [[-EventstreamDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricEventstream` function updates the name and/or description of a specified Fabric Eventstream by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the name of the Eventstream with the ID "Eventstream123" to "NewEventstreamName". + +```powershell +Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewEventstreamName" +``` + +### EXAMPLE 2 + +Updates both the name and description of the Eventstream "Eventstream123". + +```powershell +Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewName" -EventstreamDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamDescription + +(Optional) The new description for the Eventstream. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamId + +The unique identifier of the Eventstream to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamName + +The new name for the Eventstream. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Eventstream resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricEventstreamDefinition.md b/docs/en-US/Update-FabricEventstreamDefinition.md new file mode 100644 index 00000000..e5d615ed --- /dev/null +++ b/docs/en-US/Update-FabricEventstreamDefinition.md @@ -0,0 +1,208 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricEventstreamDefinition +--- + +# Update-FabricEventstreamDefinition + +## SYNOPSIS + +Updates the definition of a Eventstream in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricEventstreamDefinition [-WorkspaceId] [-EventstreamId] + [-EventstreamPathDefinition] [[-EventstreamPathPlatformDefinition] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function allows updating the content or metadata of a Eventstream in a Microsoft Fabric workspace. +The Eventstream content can be provided as file paths, and metadata updates can optionally be enabled. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the content of the Eventstream with ID `67890` in the workspace `12345` using the specified Eventstream file. + +```powershell +Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb" +``` + +### EXAMPLE 2 + +Updates both the content and metadata of the Eventstream with ID `67890` in the workspace `12345`. + +```powershell +Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb" -UpdateMetadata $true +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamId + +(Mandatory) The unique identifier of the Eventstream to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamPathDefinition + +(Mandatory) The file path to the Eventstream content definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EventstreamPathPlatformDefinition + +(Optional) The file path to the Eventstream's platform-specific definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace where the Eventstream resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- The Eventstream content is encoded as Base64 before being sent to the Fabric API. +- This function handles asynchronous operations and retrieves operation results if required. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Update-FabricKQLDashboard.md b/docs/en-US/Update-FabricKQLDashboard.md new file mode 100644 index 00000000..e4ba5c7f --- /dev/null +++ b/docs/en-US/Update-FabricKQLDashboard.md @@ -0,0 +1,203 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricKQLDashboard +--- + +# Update-FabricKQLDashboard + +## SYNOPSIS + +Updates the properties of a Fabric KQLDashboard. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricKQLDashboard [-WorkspaceId] [-KQLDashboardId] + [-KQLDashboardName] [[-KQLDashboardDescription] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricKQLDashboard` function updates the name and/or description of a specified Fabric KQLDashboard by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the name of the KQLDashboard with the ID "KQLDashboard123" to "NewKQLDashboardName". + +```powershell +Update-FabricKQLDashboard -KQLDashboardId "KQLDashboard123" -KQLDashboardName "NewKQLDashboardName" +``` + +### EXAMPLE 2 + +Updates both the name and description of the KQLDashboard "KQLDashboard123". + +```powershell +Update-FabricKQLDashboard -KQLDashboardId "KQLDashboard123" -KQLDashboardName "NewName" -KQLDashboardDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardDescription + +(Optional) The new description for the KQLDashboard. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardId + +The unique identifier of the KQLDashboard to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardName + +The new name for the KQLDashboard. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the KQLDashboard exists. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricKQLDashboardDefinition.md b/docs/en-US/Update-FabricKQLDashboardDefinition.md new file mode 100644 index 00000000..e17d4149 --- /dev/null +++ b/docs/en-US/Update-FabricKQLDashboardDefinition.md @@ -0,0 +1,208 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricKQLDashboardDefinition +--- + +# Update-FabricKQLDashboardDefinition + +## SYNOPSIS + +Updates the definition of a KQLDashboard in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricKQLDashboardDefinition [-WorkspaceId] [-KQLDashboardId] + [-KQLDashboardPathDefinition] [[-KQLDashboardPathPlatformDefinition] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function allows updating the content or metadata of a KQLDashboard in a Microsoft Fabric workspace. +The KQLDashboard content can be provided as file paths, and metadata updates can optionally be enabled. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the content of the KQLDashboard with ID `67890` in the workspace `12345` using the specified KQLDashboard file. + +```powershell +Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb" +``` + +### EXAMPLE 2 + +Updates both the content and metadata of the KQLDashboard with ID `67890` in the workspace `12345`. + +```powershell +Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardId + +(Mandatory) The unique identifier of the KQLDashboard to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardPathDefinition + +(Mandatory) The file path to the KQLDashboard content definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDashboardPathPlatformDefinition + +(Optional) The file path to the KQLDashboard's platform-specific definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace where the KQLDashboard resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- The KQLDashboard content is encoded as Base64 before being sent to the Fabric API. +- This function handles asynchronous operations and retrieves operation results if required. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Update-FabricKQLDatabase.md b/docs/en-US/Update-FabricKQLDatabase.md new file mode 100644 index 00000000..d130ccc0 --- /dev/null +++ b/docs/en-US/Update-FabricKQLDatabase.md @@ -0,0 +1,202 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricKQLDatabase +--- + +# Update-FabricKQLDatabase + +## SYNOPSIS + +Updates the properties of a Fabric KQLDatabase. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricKQLDatabase [-WorkspaceId] [-KQLDatabaseId] [-KQLDatabaseName] + [[-KQLDatabaseDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricKQLDatabase` function updates the name and/or description of a specified Fabric KQLDatabase by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the name of the KQLDatabase with the ID "KQLDatabase123" to "NewKQLDatabaseName". + +```powershell +Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewKQLDatabaseName" +``` + +### EXAMPLE 2 + +Updates both the name and description of the KQLDatabase "KQLDatabase123". + +```powershell +Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewName" -KQLDatabaseDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseDescription + +(Optional) The new description for the KQLDatabase. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseId + +The unique identifier of the KQLDatabase to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseName + +The new name for the KQLDatabase. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the KQLDatabase resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricKQLDatabaseDefinition.md b/docs/en-US/Update-FabricKQLDatabaseDefinition.md new file mode 100644 index 00000000..56992453 --- /dev/null +++ b/docs/en-US/Update-FabricKQLDatabaseDefinition.md @@ -0,0 +1,230 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricKQLDatabaseDefinition +--- + +# Update-FabricKQLDatabaseDefinition + +## SYNOPSIS + +Updates the definition of a KQLDatabase in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricKQLDatabaseDefinition [-WorkspaceId] [-KQLDatabaseId] + [-KQLDatabasePathDefinition] [[-KQLDatabasePathPlatformDefinition] ] + [[-KQLDatabasePathSchemaDefinition] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function allows updating the content or metadata of a KQLDatabase in a Microsoft Fabric workspace. +The KQLDatabase content can be provided as file paths, and metadata updates can optionally be enabled. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the content of the KQLDatabase with ID `67890` in the workspace `12345` using the specified KQLDatabase file. + +```powershell +Update-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" -KQLDatabasePathDefinition "C:\KQLDatabases\KQLDatabase.ipynb" +``` + +### EXAMPLE 2 + +Updates both the content and metadata of the KQLDatabase with ID `67890` in the workspace `12345`. + +```powershell +Update-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" -KQLDatabasePathDefinition "C:\KQLDatabases\KQLDatabase.ipynb" -UpdateMetadata $true +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabaseId + +(Mandatory) The unique identifier of the KQLDatabase to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabasePathDefinition + +(Mandatory) The file path to the KQLDatabase content definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabasePathPlatformDefinition + +(Optional) The file path to the KQLDatabase's platform-specific definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLDatabasePathSchemaDefinition + +(Optional) The file path to the KQLDatabase's schema definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace where the KQLDatabase resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- The KQLDatabase content is encoded as Base64 before being sent to the Fabric API. +- This function handles asynchronous operations and retrieves operation results if required. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Update-FabricKQLQueryset.md b/docs/en-US/Update-FabricKQLQueryset.md new file mode 100644 index 00000000..28356189 --- /dev/null +++ b/docs/en-US/Update-FabricKQLQueryset.md @@ -0,0 +1,202 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricKQLQueryset +--- + +# Update-FabricKQLQueryset + +## SYNOPSIS + +Updates the properties of a Fabric KQLQueryset. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricKQLQueryset [-WorkspaceId] [-KQLQuerysetId] [-KQLQuerysetName] + [[-KQLQuerysetDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricKQLQueryset` function updates the name and/or description of a specified Fabric KQLQueryset by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the name of the KQLQueryset with the ID "KQLQueryset123" to "NewKQLQuerysetName". + +```powershell +Update-FabricKQLQueryset -KQLQuerysetId "KQLQueryset123" -KQLQuerysetName "NewKQLQuerysetName" +``` + +### EXAMPLE 2 + +Updates both the name and description of the KQLQueryset "KQLQueryset123". + +```powershell +Update-FabricKQLQueryset -KQLQuerysetId "KQLQueryset123" -KQLQuerysetName "NewName" -KQLQuerysetDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetDescription + +(Optional) The new description for the KQLQueryset. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetId + +The unique identifier of the KQLQueryset to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetName + +The new name for the KQLQueryset. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the KQLQueryset exists. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricKQLQuerysetDefinition.md b/docs/en-US/Update-FabricKQLQuerysetDefinition.md new file mode 100644 index 00000000..2c54461c --- /dev/null +++ b/docs/en-US/Update-FabricKQLQuerysetDefinition.md @@ -0,0 +1,208 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricKQLQuerysetDefinition +--- + +# Update-FabricKQLQuerysetDefinition + +## SYNOPSIS + +Updates the definition of a KQLQueryset in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricKQLQuerysetDefinition [-WorkspaceId] [-KQLQuerysetId] + [-KQLQuerysetPathDefinition] [[-KQLQuerysetPathPlatformDefinition] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function allows updating the content or metadata of a KQLQueryset in a Microsoft Fabric workspace. +The KQLQueryset content can be provided as file paths, and metadata updates can optionally be enabled. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the content of the KQLQueryset with ID `67890` in the workspace `12345` using the specified KQLQueryset file. + +```powershell +Update-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" -KQLQuerysetPathDefinition "C:\KQLQuerysets\KQLQueryset.ipynb" +``` + +### EXAMPLE 2 + +Updates both the content and metadata of the KQLQueryset with ID `67890` in the workspace `12345`. + +```powershell +Update-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" -KQLQuerysetPathDefinition "C:\KQLQuerysets\KQLQueryset.ipynb" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetId + +(Mandatory) The unique identifier of the KQLQueryset to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetPathDefinition + +(Mandatory) The file path to the KQLQueryset content definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -KQLQuerysetPathPlatformDefinition + +(Optional) The file path to the KQLQueryset's platform-specific definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace where the KQLQueryset resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- The KQLQueryset content is encoded as Base64 before being sent to the Fabric API. +- This function handles asynchronous operations and retrieves operation results if required. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Update-FabricLakehouse.md b/docs/en-US/Update-FabricLakehouse.md new file mode 100644 index 00000000..add3ee74 --- /dev/null +++ b/docs/en-US/Update-FabricLakehouse.md @@ -0,0 +1,202 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricLakehouse +--- + +# Update-FabricLakehouse + +## SYNOPSIS + +Updates the properties of a Fabric Lakehouse. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricLakehouse [-WorkspaceId] [-LakehouseId] [-LakehouseName] + [[-LakehouseDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricLakehouse` function updates the name and/or description of a specified Fabric Lakehouse by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the name of the Lakehouse with the ID "Lakehouse123" to "NewLakehouseName". + +```powershell +Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewLakehouseName" +``` + +### EXAMPLE 2 + +Updates both the name and description of the Lakehouse "Lakehouse123". + +```powershell +Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewName" -LakehouseDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseDescription + +(Optional) The new description for the Lakehouse. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseId + +The unique identifier of the Lakehouse to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseName + +The new name for the Lakehouse. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Lakehouse exists. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricMLExperiment.md b/docs/en-US/Update-FabricMLExperiment.md new file mode 100644 index 00000000..337130a0 --- /dev/null +++ b/docs/en-US/Update-FabricMLExperiment.md @@ -0,0 +1,200 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricMLExperiment +--- + +# Update-FabricMLExperiment + +## SYNOPSIS + +Updates an existing ML Experiment in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricMLExperiment [-WorkspaceId] [-MLExperimentId] + [-MLExperimentName] [[-MLExperimentDescription] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing ML Experiment +in the specified workspace. +It supports optional parameters for ML Experiment description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the ML Experiment with ID "experiment-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" -MLExperimentName "Updated ML Experiment" -MLExperimentDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLExperimentDescription + +An optional new description for the ML Experiment. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLExperimentId + +The unique identifier of the ML Experiment to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLExperimentName + +The new name of the ML Experiment. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the ML Experiment exists. +This parameter is optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricMLModel.md b/docs/en-US/Update-FabricMLModel.md new file mode 100644 index 00000000..88ffdec5 --- /dev/null +++ b/docs/en-US/Update-FabricMLModel.md @@ -0,0 +1,177 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricMLModel +--- + +# Update-FabricMLModel + +## SYNOPSIS + +Updates an existing ML Model in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricMLModel [-WorkspaceId] [-MLModelId] [[-MLModelDescription] ] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing ML Model +in the specified workspace. +It supports optional parameters for ML Model description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the ML Model with ID "model-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" -MLModelName "Updated ML Model" -MLModelDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLModelDescription + +New description for the ML Model. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MLModelId + +The unique identifier of the ML Model to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + 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 optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricMirroredDatabase.md b/docs/en-US/Update-FabricMirroredDatabase.md new file mode 100644 index 00000000..06e1246a --- /dev/null +++ b/docs/en-US/Update-FabricMirroredDatabase.md @@ -0,0 +1,203 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricMirroredDatabase +--- + +# Update-FabricMirroredDatabase + +## SYNOPSIS + +Updates the properties of a Fabric MirroredDatabase. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricMirroredDatabase [-WorkspaceId] [-MirroredDatabaseId] + [-MirroredDatabaseName] [[-MirroredDatabaseDescription] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricMirroredDatabase` function updates the name and/or description of a specified Fabric MirroredDatabase by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the name of the MirroredDatabase with the ID "MirroredDatabase123" to "NewMirroredDatabaseName". + +```powershell +Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewMirroredDatabaseName" +``` + +### EXAMPLE 2 + +Updates both the name and description of the MirroredDatabase "MirroredDatabase123". + +```powershell +Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewName" -MirroredDatabaseDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseDescription + +(Optional) The new description for the MirroredDatabase. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseId + +The unique identifier of the MirroredDatabase to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseName + +The new name for the MirroredDatabase. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace where the MirroredDatabase resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricMirroredDatabaseDefinition.md b/docs/en-US/Update-FabricMirroredDatabaseDefinition.md new file mode 100644 index 00000000..76b1e440 --- /dev/null +++ b/docs/en-US/Update-FabricMirroredDatabaseDefinition.md @@ -0,0 +1,208 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricMirroredDatabaseDefinition +--- + +# Update-FabricMirroredDatabaseDefinition + +## SYNOPSIS + +Updates the definition of a MirroredDatabase in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricMirroredDatabaseDefinition [-WorkspaceId] [-MirroredDatabaseId] + [-MirroredDatabasePathDefinition] [[-MirroredDatabasePathPlatformDefinition] ] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function allows updating the content or metadata of a MirroredDatabase in a Microsoft Fabric workspace. +The MirroredDatabase content can be provided as file paths, and metadata updates can optionally be enabled. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the content of the MirroredDatabase with ID `67890` in the workspace `12345` using the specified MirroredDatabase file. + +```powershell +Update-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" -MirroredDatabasePathDefinition "C:\MirroredDatabases\MirroredDatabase.json" +``` + +### EXAMPLE 2 + +Updates both the content and metadata of the MirroredDatabase with ID `67890` in the workspace `12345`. + +```powershell +Update-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" -MirroredDatabasePathDefinition "C:\MirroredDatabases\MirroredDatabase.json" -UpdateMetadata $true +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabaseId + +(Mandatory) The unique identifier of the MirroredDatabase to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabasePathDefinition + +(Mandatory) The file path to the MirroredDatabase content definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -MirroredDatabasePathPlatformDefinition + +(Optional) The file path to the MirroredDatabase's platform-specific definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace where the MirroredDatabase resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- The MirroredDatabase content is encoded as Base64 before being sent to the Fabric API. +- This function handles asynchronous operations and retrieves operation results if required. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Update-FabricNotebook.md b/docs/en-US/Update-FabricNotebook.md new file mode 100644 index 00000000..153c7b35 --- /dev/null +++ b/docs/en-US/Update-FabricNotebook.md @@ -0,0 +1,202 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricNotebook +--- + +# Update-FabricNotebook + +## SYNOPSIS + +Updates the properties of a Fabric Notebook. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricNotebook [-WorkspaceId] [-NotebookId] [-NotebookName] + [[-NotebookDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricNotebook` function updates the name and/or description of a specified Fabric Notebook by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the name of the Notebook with the ID "Notebook123" to "NewNotebookName". + +```powershell +Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewNotebookName" +``` + +### EXAMPLE 2 + +Updates both the name and description of the Notebook "Notebook123". + +```powershell +Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewName" -NotebookDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookDescription + +(Optional) The new description for the Notebook. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookId + +The unique identifier of the Notebook to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookName + +The new name for the Notebook. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Notebook exists. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricNotebookDefinition.md b/docs/en-US/Update-FabricNotebookDefinition.md new file mode 100644 index 00000000..98db30cd --- /dev/null +++ b/docs/en-US/Update-FabricNotebookDefinition.md @@ -0,0 +1,208 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricNotebookDefinition +--- + +# Update-FabricNotebookDefinition + +## SYNOPSIS + +Updates the definition of a notebook in a Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricNotebookDefinition [-WorkspaceId] [-NotebookId] + [-NotebookPathDefinition] [[-NotebookPathPlatformDefinition] ] [-WhatIf] + [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function allows updating the content or metadata of a notebook in a Microsoft Fabric workspace. +The notebook content can be provided as file paths, and metadata updates can optionally be enabled. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the content of the notebook with ID `67890` in the workspace `12345` using the specified notebook file. + +```powershell +Update-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" -NotebookPathDefinition "C:\Notebooks\Notebook.ipynb" +``` + +### EXAMPLE 2 + +Updates both the content and metadata of the notebook with ID `67890` in the workspace `12345`. + +```powershell +Update-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" -NotebookPathDefinition "C:\Notebooks\Notebook.ipynb" -NotebookPathPlatformDefinition "C:\Notebooks\.platform" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookId + +(Mandatory) The unique identifier of the notebook to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookPathDefinition + +(Mandatory) The file path to the notebook content definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NotebookPathPlatformDefinition + +(Optional) The file path to the notebook's platform-specific definition file. +The content will be encoded as Base64 and sent in the request. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +(Mandatory) The unique identifier of the workspace where the notebook resides. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. +- Calls `Confirm-TokenState` to ensure token validity before making the API request. +- The notebook content is encoded as Base64 before being sent to the Fabric API. +- This function handles asynchronous operations and retrieves operation results if required. + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/docs/en-US/Update-FabricPaginatedReport.md b/docs/en-US/Update-FabricPaginatedReport.md new file mode 100644 index 00000000..da6c0805 --- /dev/null +++ b/docs/en-US/Update-FabricPaginatedReport.md @@ -0,0 +1,200 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricPaginatedReport +--- + +# Update-FabricPaginatedReport + +## SYNOPSIS + +Updates an existing paginated report in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricPaginatedReport [-WorkspaceId] [-PaginatedReportId] + [-PaginatedReportName] [[-PaginatedReportDescription] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing paginated report +in the specified workspace. +It supports optional parameters for paginated report description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the paginated report with ID "report-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricPaginatedReport -WorkspaceId "workspace-12345" -PaginatedReportId "report-67890" -PaginatedReportName "Updated Paginated Report" -PaginatedReportDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PaginatedReportDescription + +An optional new description for the paginated report. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PaginatedReportId + +The unique identifier of the paginated report to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PaginatedReportName + +The new name of the paginated report. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the paginated report exists. +This parameter is optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricReflex.md b/docs/en-US/Update-FabricReflex.md new file mode 100644 index 00000000..963855d4 --- /dev/null +++ b/docs/en-US/Update-FabricReflex.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricReflex +--- + +# Update-FabricReflex + +## SYNOPSIS + +Updates an existing Reflex in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricReflex [-WorkspaceId] [-ReflexId] [-ReflexName] + [[-ReflexDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing Reflex +in the specified workspace. +It supports optional parameters for Reflex description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexName "Updated Reflex" -ReflexDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexDescription + +An optional new description for the Reflex. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexId + +The unique identifier of the Reflex to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexName + +The new name of the Reflex. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Reflex exists. +This parameter is optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricReflexDefinition.md b/docs/en-US/Update-FabricReflexDefinition.md new file mode 100644 index 00000000..d7006431 --- /dev/null +++ b/docs/en-US/Update-FabricReflexDefinition.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricReflexDefinition +--- + +# Update-FabricReflexDefinition + +## SYNOPSIS + +Updates the definition of an existing Reflex in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricReflexDefinition [-WorkspaceId] [-ReflexId] + [-ReflexPathDefinition] [[-ReflexPathPlatformDefinition] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Reflex +in the specified workspace. +It supports optional parameters for Reflex definition and platform-specific definition. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the definition of the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345" using the provided definition file. + +```powershell +Update-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexPathDefinition "C:\Path\To\ReflexDefinition.json" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexId + +The unique identifier of the Reflex to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexPathDefinition + +An optional path to the Reflex definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReflexPathPlatformDefinition + +An optional path to the platform-specific definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Reflex exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricReport.md b/docs/en-US/Update-FabricReport.md new file mode 100644 index 00000000..c1123dda --- /dev/null +++ b/docs/en-US/Update-FabricReport.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricReport +--- + +# Update-FabricReport + +## SYNOPSIS + +Updates an existing Report in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricReport [-WorkspaceId] [-ReportId] [-ReportName] + [[-ReportDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing Report +in the specified workspace. +It supports optional parameters for Report description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the Report with ID "Report-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportName "Updated Report" -ReportDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportDescription + +An optional new description for the Report. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportId + +The unique identifier of the Report to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportName + +The new name of the Report. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Report exists. +This parameter is optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricReportDefinition.md b/docs/en-US/Update-FabricReportDefinition.md new file mode 100644 index 00000000..0993eae4 --- /dev/null +++ b/docs/en-US/Update-FabricReportDefinition.md @@ -0,0 +1,177 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricReportDefinition +--- + +# Update-FabricReportDefinition + +## SYNOPSIS + +Updates the definition of an existing Report in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricReportDefinition [-WorkspaceId] [-ReportId] + [-ReportPathDefinition] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Report +in the specified workspace. +It supports optional parameters for Report definition and platform-specific definition. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the definition of the Report with ID "Report-67890" in the workspace with ID "workspace-12345" using the provided definition file. + +```powershell +Update-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportPathDefinition "C:\Path\To\ReportDefinition.json" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportId + +The unique identifier of the Report to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -ReportPathDefinition + +A mandatory path to the Report definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Report exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricSemanticModel.md b/docs/en-US/Update-FabricSemanticModel.md new file mode 100644 index 00000000..239e398b --- /dev/null +++ b/docs/en-US/Update-FabricSemanticModel.md @@ -0,0 +1,200 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricSemanticModel +--- + +# Update-FabricSemanticModel + +## SYNOPSIS + +Updates an existing SemanticModel in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricSemanticModel [-WorkspaceId] [-SemanticModelId] + [-SemanticModelName] [[-SemanticModelDescription] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing SemanticModel +in the specified workspace. +It supports optional parameters for SemanticModel description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelName "Updated SemanticModel" -SemanticModelDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelDescription + +An optional new description for the SemanticModel. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelId + +The unique identifier of the SemanticModel to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelName + +The new name of the SemanticModel. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + 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 optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricSemanticModelDefinition.md b/docs/en-US/Update-FabricSemanticModelDefinition.md new file mode 100644 index 00000000..a7f205a5 --- /dev/null +++ b/docs/en-US/Update-FabricSemanticModelDefinition.md @@ -0,0 +1,177 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricSemanticModelDefinition +--- + +# Update-FabricSemanticModelDefinition + +## SYNOPSIS + +Updates the definition of an existing SemanticModel in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricSemanticModelDefinition [-WorkspaceId] [-SemanticModelId] + [-SemanticModelPathDefinition] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SemanticModel +in the specified workspace. +It supports optional parameters for SemanticModel definition and platform-specific definition. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" using the provided definition file. + +```powershell +Update-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelPathDefinition "C:\Path\To\SemanticModelDefinition.json" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelId + +The unique identifier of the SemanticModel to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SemanticModelPathDefinition + +An optional path to the SemanticModel definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + 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. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricSparkCustomPool.md b/docs/en-US/Update-FabricSparkCustomPool.md new file mode 100644 index 00000000..4d00e144 --- /dev/null +++ b/docs/en-US/Update-FabricSparkCustomPool.md @@ -0,0 +1,357 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricSparkCustomPool +--- + +# Update-FabricSparkCustomPool + +## SYNOPSIS + +Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricSparkCustomPool [-WorkspaceId] [-SparkCustomPoolId] + [-InstancePoolName] [-NodeFamily] [-NodeSize] [-AutoScaleEnabled] + [-AutoScaleMinNodeCount] [-AutoScaleMaxNodeCount] + [-DynamicExecutorAllocationEnabled] [-DynamicExecutorAllocationMinExecutors] + [-DynamicExecutorAllocationMaxExecutors] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool +in the specified workspace. +It supports various parameters for Spark custom pool configuration. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the Spark custom pool with ID "pool-67890" in the workspace with ID "workspace-12345" with a new name and configuration. + +```powershell +Update-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolId "pool-67890" -InstancePoolName "Updated Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 +``` + +## PARAMETERS + +### -AutoScaleEnabled + +Specifies whether auto-scaling is enabled for the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 5 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -AutoScaleMaxNodeCount + +The maximum number of nodes for auto-scaling in the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 7 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -AutoScaleMinNodeCount + +The minimum number of nodes for auto-scaling in the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 6 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DynamicExecutorAllocationEnabled + +Specifies whether dynamic executor allocation is enabled for the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 8 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DynamicExecutorAllocationMaxExecutors + +The maximum number of executors for dynamic executor allocation in the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 10 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -DynamicExecutorAllocationMinExecutors + +The minimum number of executors for dynamic executor allocation in the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 9 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -InstancePoolName + +The new name of the Spark custom pool. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NodeFamily + +The family of nodes to be used in the Spark custom pool. +This parameter is mandatory and must be 'MemoryOptimized'. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -NodeSize + +The size of the nodes to be used in the Spark custom pool. +This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkCustomPoolId + +The unique identifier of the Spark custom pool to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Spark custom pool exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricSparkJobDefinition.md b/docs/en-US/Update-FabricSparkJobDefinition.md new file mode 100644 index 00000000..0c334fef --- /dev/null +++ b/docs/en-US/Update-FabricSparkJobDefinition.md @@ -0,0 +1,200 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricSparkJobDefinition +--- + +# Update-FabricSparkJobDefinition + +## SYNOPSIS + +Updates an existing SparkJobDefinition in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricSparkJobDefinition [-WorkspaceId] [-SparkJobDefinitionId] + [-SparkJobDefinitionName] [[-SparkJobDefinitionDescription] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing SparkJobDefinition +in the specified workspace. +It supports optional parameters for SparkJobDefinition description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionName "Updated SparkJobDefinition" -SparkJobDefinitionDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionDescription + +An optional new description for the SparkJobDefinition. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionId + +The unique identifier of the SparkJobDefinition to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionName + +The new name of the SparkJobDefinition. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the SparkJobDefinition exists. +This parameter is optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricSparkJobDefinitionDefinition.md b/docs/en-US/Update-FabricSparkJobDefinitionDefinition.md new file mode 100644 index 00000000..52708f76 --- /dev/null +++ b/docs/en-US/Update-FabricSparkJobDefinitionDefinition.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricSparkJobDefinitionDefinition +--- + +# Update-FabricSparkJobDefinitionDefinition + +## SYNOPSIS + +Updates the definition of an existing SparkJobDefinition in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricSparkJobDefinitionDefinition [-WorkspaceId] [-SparkJobDefinitionId] + [-SparkJobDefinitionPathDefinition] [[-SparkJobDefinitionPathPlatformDefinition] ] + [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SparkJobDefinition +in the specified workspace. +It supports optional parameters for SparkJobDefinition definition and platform-specific definition. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" using the provided definition file. + +```powershell +Update-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionPathDefinition "C:\Path\To\SparkJobDefinitionDefinition.json" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionId + +The unique identifier of the SparkJobDefinition to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionPathDefinition + +An optional path to the SparkJobDefinition definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -SparkJobDefinitionPathPlatformDefinition + +An optional path to the platform-specific definition file to upload. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the SparkJobDefinition exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricSparkSettings.md b/docs/en-US/Update-FabricSparkSettings.md new file mode 100644 index 00000000..7d563fa1 --- /dev/null +++ b/docs/en-US/Update-FabricSparkSettings.md @@ -0,0 +1,335 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricSparkSettings +--- + +# Update-FabricSparkSettings + +## SYNOPSIS + +Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricSparkSettings [-WorkspaceId] [[-automaticLogEnabled] ] + [[-notebookInteractiveRunEnabled] ] [[-customizeComputeEnabled] ] + [[-defaultPoolName] ] [[-defaultPoolType] ] [[-starterPoolMaxNode] ] + [[-starterPoolMaxExecutors] ] [[-EnvironmentName] ] + [[-EnvironmentRuntimeVersion] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool +in the specified workspace. +It supports various parameters for Spark custom pool configuration. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the Spark custom pool with ID "pool-67890" in the workspace with ID "workspace-12345" with a new name and configuration. + +```powershell +Update-FabricSparkSettings -WorkspaceId "workspace-12345" -SparkSettingsId "pool-67890" -InstancePoolName "Updated Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 +``` + +## PARAMETERS + +### -automaticLogEnabled + +Specifies whether automatic logging is enabled for the Spark custom pool. +This parameter is optional. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -customizeComputeEnabled + +Specifies whether compute customization is enabled for the Spark custom pool. +This parameter is optional. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -defaultPoolName + +The name of the default pool for the Spark custom pool. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -defaultPoolType + +The type of the default pool for the Spark custom pool. +This parameter is optional and must be either 'Workspace' or 'Capacity'. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 5 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentName + +The name of the environment for the Spark custom pool. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 8 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -EnvironmentRuntimeVersion + +The runtime version of the environment for the Spark custom pool. +This parameter is optional. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 9 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -notebookInteractiveRunEnabled + +Specifies whether notebook interactive run is enabled for the Spark custom pool. +This parameter is optional. + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -starterPoolMaxExecutors + +The maximum number of executors for the starter pool in the Spark custom pool. +This parameter is optional. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 7 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -starterPoolMaxNode + +The maximum number of nodes for the starter pool in the Spark custom pool. +This parameter is optional. + +```yaml +Type: System.Int32 +DefaultValue: 0 +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 6 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the Spark custom pool exists. +This parameter is mandatory. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricWarehouse.md b/docs/en-US/Update-FabricWarehouse.md new file mode 100644 index 00000000..1e4ab806 --- /dev/null +++ b/docs/en-US/Update-FabricWarehouse.md @@ -0,0 +1,199 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricWarehouse +--- + +# Update-FabricWarehouse + +## SYNOPSIS + +Updates an existing warehouse in a specified Microsoft Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricWarehouse [-WorkspaceId] [-WarehouseId] [-WarehouseName] + [[-WarehouseDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +This function sends a PATCH request to the Microsoft Fabric API to update an existing warehouse +in the specified workspace. +It supports optional parameters for warehouse description. + +## EXAMPLES + +### EXAMPLE 1 + +This example updates the warehouse with ID "warehouse-67890" in the workspace with ID "workspace-12345" with a new name and description. + +```powershell +Update-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" -WarehouseName "Updated Warehouse" -WarehouseDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WarehouseDescription + +An optional new description for the warehouse. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WarehouseId + +The unique identifier of the warehouse to be updated. +This parameter is mandatory. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WarehouseName + +The new name of the warehouse. +This parameter is mandatory. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the warehouse exists. +This parameter is optional. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricWorkspace.md b/docs/en-US/Update-FabricWorkspace.md new file mode 100644 index 00000000..8a33c142 --- /dev/null +++ b/docs/en-US/Update-FabricWorkspace.md @@ -0,0 +1,181 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricWorkspace +--- + +# Update-FabricWorkspace + +## SYNOPSIS + +Updates the properties of a Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricWorkspace [-WorkspaceId] [-WorkspaceName] + [[-WorkspaceDescription] ] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricWorkspace` function updates the name and/or description of a specified Fabric workspace by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the name of the workspace with the ID "workspace123" to "NewWorkspaceName". + +```powershell +Update-FabricWorkspace -WorkspaceId "workspace123" -WorkspaceName "NewWorkspaceName" +``` + +### EXAMPLE 2 + +Updates both the name and description of the workspace "workspace123". + +```powershell +Update-FabricWorkspace -WorkspaceId "workspace123" -WorkspaceName "NewName" -WorkspaceDescription "Updated description" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceDescription + +(Optional) The new description for the workspace. + +```yaml +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 to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceName + +The new name for the workspace. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Update-FabricWorkspaceRoleAssignment.md b/docs/en-US/Update-FabricWorkspaceRoleAssignment.md new file mode 100644 index 00000000..a9610fb0 --- /dev/null +++ b/docs/en-US/Update-FabricWorkspaceRoleAssignment.md @@ -0,0 +1,178 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Update-FabricWorkspaceRoleAssignment +--- + +# Update-FabricWorkspaceRoleAssignment + +## SYNOPSIS + +Updates the role assignment for a specific principal in a Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Update-FabricWorkspaceRoleAssignment [-WorkspaceId] [-WorkspaceRoleAssignmentId] + [-WorkspaceRole] [-WhatIf] [-Confirm] [] +``` + +## ALIASES + +## DESCRIPTION + +The `Update-FabricWorkspaceRoleAssignment` function updates the role assigned to a principal in a workspace by making a PATCH request to the API. + +## EXAMPLES + +### EXAMPLE 1 + +Updates the role assignment to "Admin" for the specified workspace and role assignment. + +```powershell +Update-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "assignment456" -WorkspaceRole "Admin" +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The unique identifier of the workspace where the role assignment exists. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceRole + +The new role to assign to the principal. +Must be one of the following: +- Admin +- Contributor +- Member +- Viewer + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceRoleAssignmentId + +The unique identifier of the role assignment to be updated. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 }} + diff --git a/docs/en-US/Write-FabricLakehouseTableData.md b/docs/en-US/Write-FabricLakehouseTableData.md new file mode 100644 index 00000000..dc4b47d3 --- /dev/null +++ b/docs/en-US/Write-FabricLakehouseTableData.md @@ -0,0 +1,330 @@ +--- +document type: cmdlet +external help file: FabricTools-Help.xml +HelpUri: '' +Locale: en-US +Module Name: FabricTools +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 +title: Write-FabricLakehouseTableData +--- + +# Write-FabricLakehouseTableData + +## SYNOPSIS + +Loads data into a specified table in a Lakehouse within a Fabric workspace. + +## SYNTAX + +### __AllParameterSets + +``` +Write-FabricLakehouseTableData [-WorkspaceId] [-LakehouseId] [-TableName] + [-PathType] [-RelativePath] [-FileFormat] [[-CsvDelimiter] ] + [[-CsvHeader] ] [-Mode] [[-Recursive] ] [-WhatIf] [-Confirm] + [] +``` + +## ALIASES + +Import-FabricLakehouseTableData + +## DESCRIPTION + +Loads data into a specified table in a Lakehouse within a Fabric workspace. +The function supports loading data from files or folders, with options for file format and CSV settings. + +## EXAMPLES + +### EXAMPLE 1 + +This example loads data from a CSV file into the specified table in the Lakehouse. + +```powershell +Import-FabricLakehouseTableData -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -TableName "your-table-name" -PathType "File" -RelativePath "path/to/your/file.csv" -FileFormat "CSV" -CsvDelimiter "," -CsvHeader $true -Mode "append" -Recursive $false +``` + +### EXAMPLE 2 + +This example loads data from a folder into the specified table in the Lakehouse, overwriting any existing data. + +```powershell +Import-FabricLakehouseTableData -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -TableName "your-table-name" -PathType "Folder" -RelativePath "path/to/your/folder" -FileFormat "Parquet" -Mode "overwrite" -Recursive $true +``` + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CsvDelimiter + +The delimiter used in the CSV file (default is comma). + +```yaml +Type: System.String +DefaultValue: ',' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 6 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -CsvHeader + +Indicates whether the CSV file has a header row (default is false). + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 7 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -FileFormat + +The format of the file to load data from (CSV or Parquet). + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 5 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -LakehouseId + +The ID of the Lakehouse where the table resides. + +```yaml +Type: System.Guid +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Mode + +The mode for loading data (append or overwrite). + +```yaml +Type: System.String +DefaultValue: append +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 8 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -PathType + +The type of path to load data from (File or Folder). + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 3 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -Recursive + +Indicates whether to load data recursively from subfolders (default is false). + +```yaml +Type: System.Boolean +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 9 + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -RelativePath + +The relative path to the file or folder to load data from. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 4 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -TableName + +The name of the table to load data into. + +```yaml +Type: System.String +DefaultValue: '' +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WhatIf + +Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +DefaultValue: '' +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' +``` + +### -WorkspaceId + +The ID of the workspace containing the Lakehouse. + +```yaml +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Author: Tiago Balabuch + +## RELATED LINKS + +{{ Fill in the related links here }} + diff --git a/documentation/Add-FabricDomainWorkspaceAssignmentByCapacity.md b/documentation/Add-FabricDomainWorkspaceAssignmentByCapacity.md deleted file mode 100644 index 3e338496..00000000 --- a/documentation/Add-FabricDomainWorkspaceAssignmentByCapacity.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Add-FabricDomainWorkspaceAssignmentByCapacity - -## SYNOPSIS -Assigns workspaces to a Fabric domain based on specified capacities. - -## SYNTAX - -``` -Add-FabricDomainWorkspaceAssignmentByCapacity [-DomainId] [-CapacitiesIds] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Add-FabricDomainWorkspaceAssignmentByCapacity\` function assigns workspaces to a Fabric domain using a list of capacity IDs by making a POST request to the relevant API endpoint. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricDomainWorkspaceAssignmentByCapacity -DomainId "12345" -CapacitiesIds @("capacity1", "capacity2") -``` - -Assigns workspaces to the domain with ID "12345" based on the specified capacities. - -## PARAMETERS - -### -CapacitiesIds -An array of capacity IDs used to assign workspaces to the domain. - -```yaml -Type: System.Guid[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainId -The unique identifier of the Fabric domain to which the workspaces will be assigned. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Add-FabricDomainWorkspaceAssignmentById.md b/documentation/Add-FabricDomainWorkspaceAssignmentById.md deleted file mode 100644 index 4c5b138e..00000000 --- a/documentation/Add-FabricDomainWorkspaceAssignmentById.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Add-FabricDomainWorkspaceAssignmentById - -## SYNOPSIS -Assigns workspaces to a specified domain in Microsoft Fabric by their IDs. - -## SYNTAX - -``` -Add-FabricDomainWorkspaceAssignmentById [-DomainId] [-WorkspaceIds] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Add-FabricDomainWorkspaceAssignmentById\` function sends a request to assign multiple workspaces to a specified domain using the provided domain ID and an array of workspace IDs. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricDomainWorkspaceAssignmentById -DomainId "12345" -WorkspaceIds @("ws1", "ws2", "ws3") -``` - -Assigns the workspaces with IDs "ws1", "ws2", and "ws3" to the domain with ID "12345". - -## PARAMETERS - -### -DomainId -The ID of the domain to which workspaces will be assigned. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceIds -An array of workspace IDs to be assigned to the domain. -This parameter is mandatory. - -```yaml -Type: System.Guid[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Add-FabricDomainWorkspaceAssignmentByPrincipal.md b/documentation/Add-FabricDomainWorkspaceAssignmentByPrincipal.md deleted file mode 100644 index f8ff2ef9..00000000 --- a/documentation/Add-FabricDomainWorkspaceAssignmentByPrincipal.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Add-FabricDomainWorkspaceAssignmentByPrincipal - -## SYNOPSIS -Assigns workspaces to a domain based on principal IDs in Microsoft Fabric. - -## SYNTAX - -``` -Add-FabricDomainWorkspaceAssignmentByPrincipal [-DomainId] [-PrincipalIds] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Add-FabricDomainWorkspaceAssignmentByPrincipal\` function sends a request to assign workspaces to a specified domain using a JSON object of principal IDs and types. - -## EXAMPLES - -### EXAMPLE 1 -``` -$PrincipalIds = @( - @{id = "813abb4a-414c-4ac0-9c2c-bd17036fd58c"; type = "User"}, - @{id = "b5b9495c-685a-447a-b4d3-2d8e963e6288"; type = "User"} - ) -``` - -Add-FabricDomainWorkspaceAssignmentByPrincipal -DomainId "12345" -PrincipalIds $principals - -Assigns the workspaces based on the provided principal IDs and types. - -## PARAMETERS - -### -DomainId -The ID of the domain to which workspaces will be assigned. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalIds -An array representing the principals with their \`id\` and \`type\` properties. -Must contain a \`principals\` key with an array of objects. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Add-FabricDomainWorkspaceRoleAssignment.md b/documentation/Add-FabricDomainWorkspaceRoleAssignment.md deleted file mode 100644 index d8be69d3..00000000 --- a/documentation/Add-FabricDomainWorkspaceRoleAssignment.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Add-FabricDomainWorkspaceRoleAssignment - -## SYNOPSIS -Bulk assigns roles to principals for workspaces in a Fabric domain. - -## SYNTAX - -``` -Add-FabricDomainWorkspaceRoleAssignment [-DomainId] [-DomainRole] [-PrincipalIds] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`AssignFabricDomainWorkspaceRoleAssignment\` function performs bulk role assignments for principals in a specific Fabric domain. -It sends a POST request to the relevant API endpoint. - -## EXAMPLES - -### EXAMPLE 1 -``` -AssignFabricDomainWorkspaceRoleAssignment -DomainId "12345" -DomainRole "Admins" -PrincipalIds @(@{id="user1"; type="User"}, @{id="group1"; type="Group"}) -``` - -Assigns the \`Admins\` role to the specified principals in the domain with ID "12345". - -## PARAMETERS - -### -DomainId -The unique identifier of the Fabric domain where roles will be assigned. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainRole -The role to assign to the principals. -Must be one of the following: -- \`Admins\` -- \`Contributors\` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalIds -An array of principals to assign roles to. -Each principal must include: -- \`id\`: The identifier of the principal. -- \`type\`: The type of the principal (e.g., \`User\`, \`Group\`). - -```yaml -Type: System.Array -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Add-FabricWorkspaceCapacityAssignment.md b/documentation/Add-FabricWorkspaceCapacityAssignment.md deleted file mode 100644 index b26e12c2..00000000 --- a/documentation/Add-FabricWorkspaceCapacityAssignment.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Add-FabricWorkspaceCapacityAssignment - -## SYNOPSIS -Assigns a Fabric workspace to a specified capacity. - -## SYNTAX - -``` -Add-FabricWorkspaceCapacityAssignment [-WorkspaceId] [-CapacityId] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Add-FabricWorkspaceCapacityAssignment\` function sends a POST request to assign a workspace to a specific capacity. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricWorkspaceCapacityAssignment -WorkspaceId "workspace123" -CapacityId "capacity456" -``` - -Assigns the workspace with ID "workspace123" to the capacity "capacity456". - -## PARAMETERS - -### -CapacityId -The unique identifier of the capacity to which the workspace should be assigned. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace to be assigned. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Add-FabricWorkspaceIdentity.md b/documentation/Add-FabricWorkspaceIdentity.md deleted file mode 100644 index e7a3f0b0..00000000 --- a/documentation/Add-FabricWorkspaceIdentity.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Add-FabricWorkspaceIdentity - -## SYNOPSIS -Provisions an identity for a Fabric workspace. - -## SYNTAX - -``` -Add-FabricWorkspaceIdentity [-WorkspaceId] [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Add-FabricWorkspaceIdentity\` function provisions an identity for a specified workspace by making an API call. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricWorkspaceIdentity -WorkspaceId "workspace123" -``` - -Provisions a Managed Identity for the workspace with ID "workspace123". - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace for which the identity will be provisioned. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Add-FabricWorkspaceRoleAssignment.md b/documentation/Add-FabricWorkspaceRoleAssignment.md deleted file mode 100644 index 2ce4c96e..00000000 --- a/documentation/Add-FabricWorkspaceRoleAssignment.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Add-FabricWorkspaceRoleAssignment - -## SYNOPSIS -Assigns a role to a principal for a specified Fabric workspace. - -## SYNTAX - -``` -Add-FabricWorkspaceRoleAssignment [-WorkspaceId] [-PrincipalId] [-PrincipalType] - [-WorkspaceRole] [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Add-FabricWorkspaceRoleAssignments\` function assigns a role (e.g., Admin, Contributor, Member, Viewer) to a principal (e.g., User, Group, ServicePrincipal) in a Fabric workspace by making a POST request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -PrincipalId "principal123" -PrincipalType "User" -WorkspaceRole "Admin" -``` - -Assigns the Admin role to the user with ID "principal123" in the workspace "workspace123". - -## PARAMETERS - -### -PrincipalId -The unique identifier of the principal (User, Group, etc.) to assign the role. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalType -The type of the principal. -Allowed values: Group, ServicePrincipal, ServicePrincipalProfile, User. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceRole -The role to assign to the principal. -Allowed values: Admin, Contributor, Member, Viewer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Collections.Hashtable -## 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 diff --git a/documentation/Connect-FabricAccount.md b/documentation/Connect-FabricAccount.md deleted file mode 100644 index 462e4532..00000000 --- a/documentation/Connect-FabricAccount.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Connect-FabricAccount - -## SYNOPSIS -Connects to the Fabric WebAPI. - -## SYNTAX - -``` -Connect-FabricAccount [[-TenantId] ] [[-ServicePrincipalId] ] - [[-ServicePrincipalSecret] ] [[-Credential] ] [-Reset] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Connects to the Fabric WebAPI by using the cmdlet Connect-AzAccount. -This function retrieves the authentication token for the Fabric API and sets up the headers for API calls. - -## EXAMPLES - -### EXAMPLE 1 -``` -Connect-FabricAccount -TenantId '12345678-1234-1234-1234-123456789012' -``` - -Connects to the stated Tenant with exisitng credentials - -### EXAMPLE 2 -``` -$credential = Get-Credential -Connect-FabricAccount -TenantId 'xxx' -credential $credential -``` - -Prompts for Service Principal id and secret and connects as that Service Principal - -### EXAMPLE 3 -``` -Connect-FabricAccount -TenantId 'xxx' -ServicePrincipalId 'appId' -ServicePrincipalSecret $secret -``` - -Connects as Service Principal using id and secret - -## PARAMETERS - -### -Credential -A PSCredential object representing a user credential (username and secure password). - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reset -A switch parameter. -If provided, the function resets the Fabric authentication token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalId -The Client ID (AppId) of the service principal used for authentication. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: AppId - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalSecret -The **secure string** representing the service principal secret. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: AppSecret - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantId -The TenantId of the Azure Active Directory tenant you want to connect to and in which your Fabric Capacity is. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### None. This function does not return any output. -## NOTES -Revision History: - -- 2024-12-22 - FGE: Added Verbose Output -- 2025-05-26 - Jojobit: Added Service Principal support, with secure string handling and parameter descriptions, as supported by the original FabTools module -- 2025-06-02 - KNO: Added Reset switch to force re-authentication and token refresh - -Author: Frank Geisler, Kamil Nowinski - -## RELATED LINKS - -[Connect-AzAccount https://learn.microsoft.com/de-de/powershell/module/az.accounts/connect-azaccount?view=azps-12.4.0]() - diff --git a/documentation/Export-FabricItem.md b/documentation/Export-FabricItem.md deleted file mode 100644 index 9633f96c..00000000 --- a/documentation/Export-FabricItem.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Export-FabricItem - -## SYNOPSIS -Exports items from a Fabric workspace. -Either all items in a workspace or a specific item. - -## SYNTAX - -``` -Export-FabricItem [[-path] ] [[-WorkspaceId] ] [[-filter] ] [[-itemID] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The Export-FabricItem function exports items from a Fabric workspace to a specified directory. -It can export items of type "Report", "SemanticModel", "SparkJobDefinitionV1" or "Notebook". -If a specific item ID is provided, only that item will be exported. -Otherwise, all items in the workspace will be exported. - -## EXAMPLES - -### EXAMPLE 1 -``` -Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -path "C:\ExportedItems" -``` - -This example exports all items from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory. - -### EXAMPLE 2 -``` -Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -itemID "98765432-4321-4321-4321-9876543210BA" -path "C:\ExportedItems" -``` - -This example exports the item with the specified ID from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory. - -## PARAMETERS - -### -filter -A script block used to filter the items to be exported. -Only items that match the filter will be exported. -The default filter includes items of type "Report", "SemanticModel", "SparkJobDefinitionV1" or "Notebook". - -```yaml -Type: System.Management.Automation.ScriptBlock -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: { $_.type -in @("Report", "SemanticModel", "Notebook", "SparkJobDefinitionV1") } -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -itemID -The ID of the specific item to export. -If provided, only that item will be exported. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -path -The path to the directory where the items will be exported. -The default value is '.\pbipOutput'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: .\pbipOutput -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the Fabric workspace. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Rui Romano - -This function is based on the Export-FabricItems function written by Rui Romano. -https://github.com/microsoft/Analysis-Services/tree/master/pbidevmode/fabricps-pbip - -## RELATED LINKS diff --git a/documentation/Get-FabricAuthToken.md b/documentation/Get-FabricAuthToken.md deleted file mode 100644 index a462e849..00000000 --- a/documentation/Get-FabricAuthToken.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricAuthToken - -## SYNOPSIS -Retrieves the Fabric API authentication token. - -## SYNTAX - -``` -Get-FabricAuthToken [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-FabricAuthToken function retrieves the Fabric API authentication token. -If the token is not already set, the function fails. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricAuthToken -``` - -This command retrieves the Fabric API authentication token. - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None. You cannot pipe inputs to this function. -## OUTPUTS - -### String. This function returns the Fabric API authentication token. -## NOTES -Author: Rui Romano - -## RELATED LINKS diff --git a/documentation/Get-FabricCapacities.md b/documentation/Get-FabricCapacities.md deleted file mode 100644 index 4f83073d..00000000 --- a/documentation/Get-FabricCapacities.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricCapacities - -## SYNOPSIS -This function retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided. - -## SYNTAX - -``` -Get-FabricCapacities [[-subscriptionID] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-AllFabricCapacities function is used to retrieve all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided. -It uses the Az module to interact with Azure. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-AllFabricCapacities -subscriptionID "12345678-1234-1234-1234-123456789012" -``` - -This command retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in the subscription with the ID "12345678-1234-1234-1234-123456789012". - -### EXAMPLE 2 -``` -Get-AllFabricCapacities -``` - -This command retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in all subscriptions. - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -subscriptionID -An optional parameter that specifies the subscription ID. -If this parameter is not provided, the function will retrieve resources from all subscriptions. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Ioana Bouariu -Imported into FabricTools April 2025 -Alias: Get-AllFabCapacities - -## RELATED LINKS diff --git a/documentation/Get-FabricCapacity.md b/documentation/Get-FabricCapacity.md deleted file mode 100644 index f7cfdfc7..00000000 --- a/documentation/Get-FabricCapacity.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricCapacity - -## SYNOPSIS -Retrieves capacity details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricCapacity [[-capacityId] ] [[-capacityName] ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -This function retrieves capacity details from a specified workspace using either the provided capacityId or capacityName. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricCapacity -capacityId "capacity-12345" -This example retrieves the capacity details for the capacity with ID "capacity-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricCapacity -capacityName "MyCapacity" -This example retrieves the capacity details for the capacity named "MyCapacity". -``` - -## PARAMETERS - -### -capacityId -The unique identifier of the capacity to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -capacityName -The name of the capacity to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricCapacitySkus.md b/documentation/Get-FabricCapacitySkus.md deleted file mode 100644 index 8b3b65a9..00000000 --- a/documentation/Get-FabricCapacitySkus.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricCapacitySkus - -## SYNOPSIS -Retrieves the fabric capacity information. - -## SYNTAX - -``` -Get-FabricCapacitySkus [-subscriptionID] [-ResourceGroupName] [-capacity] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function makes a GET request to the Fabric API to retrieve the tenant settings. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricCapacitySkus -capacity "exampleCapacity" -Retrieves the fabric capacity information for the specified capacity. -``` - -## PARAMETERS - -### -capacity -Specifies the capacity to retrieve information for. -If not provided, all capacities will be retrieved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which the Fabric capacity is located. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -subscriptionID -Specifies the subscription ID for the Azure subscription. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Kamil Nowinski - -## RELATED LINKS diff --git a/documentation/Get-FabricCapacityState.md b/documentation/Get-FabricCapacityState.md deleted file mode 100644 index e88df638..00000000 --- a/documentation/Get-FabricCapacityState.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricCapacityState - -## SYNOPSIS -Retrieves the state of a specific capacity. - -## SYNTAX - -``` -Get-FabricCapacityState [-subscriptionID] [-resourcegroup] [-capacity] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-FabricCapacityState function retrieves the state of a specific capacity. -It supports multiple aliases for flexibility. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricCapacityState -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" -``` - -This example retrieves the state of a specific capacity given the subscription ID, resource group, and capacity. - -## PARAMETERS - -### -capacity -The capacity. -This is a mandatory parameter. -This is a parameter found in Azure, not Fabric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -resourcegroup -The resource group. -This is a mandatory parameter. -This is a parameter found in Azure, not Fabric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -subscriptionID -The ID of the subscription. -This is a mandatory parameter. -This is a parameter found in Azure, not Fabric. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -The function checks if the Azure token is null. -If it is, it connects to the Azure account and retrieves the token. -It then defines the headers for the GET request and the URL for the GET request. -Finally, it makes the GET request and returns the response. - -Author: Ioana Bouariu - -## RELATED LINKS diff --git a/documentation/Get-FabricCapacityTenantSettingOverrides.md b/documentation/Get-FabricCapacityTenantSettingOverrides.md deleted file mode 100644 index 85999573..00000000 --- a/documentation/Get-FabricCapacityTenantSettingOverrides.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricCapacityTenantSettingOverrides - -## SYNOPSIS -Retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant. - -## SYNTAX - -``` -Get-FabricCapacityTenantSettingOverrides [[-CapacityId] ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -The \`Get-FabricCapacityTenantSettingOverrides\` function retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant by making a GET request to the appropriate API endpoint. -If a \`capacityId\` is provided, the function retrieves overrides for that specific capacity. -Otherwise, it retrieves overrides for all capacities. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricCapacityTenantSettingOverrides -``` - -Returns all capacities tenant setting overrides. - -### EXAMPLE 2 -``` -Get-FabricCapacityTenantSettingOverrides -capacityId "12345" -``` - -Returns tenant setting overrides for the capacity with ID "12345". - -## PARAMETERS - -### -CapacityId -The ID of the capacity for which tenant setting overrides should be retrieved. -If not provided, overrides for all capacities will be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricConfig.md b/documentation/Get-FabricConfig.md deleted file mode 100644 index 27944089..00000000 --- a/documentation/Get-FabricConfig.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricConfig - -## SYNOPSIS -Gets the configuration for use with all functions in the PSFabricTools module. - -## SYNTAX - -``` -Get-FabricConfig [[-ConfigName] ] -``` - -## DESCRIPTION -Gets the configuration for use with all functions in the PSFabricTools module. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricConfig -``` - -Gets all the configuration values for the PSFabricTools module and outputs them. - -### EXAMPLE 2 -``` -Get-FabricConfig -ConfigName BaseUrl -``` - -Gets the BaseUrl configuration value for the PSFabricTools module. - -## PARAMETERS - -### -ConfigName -The name of the configuration to be retrieved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Jess Pomfret - -## RELATED LINKS diff --git a/documentation/Get-FabricCopyJob.md b/documentation/Get-FabricCopyJob.md deleted file mode 100644 index 7fa2e151..00000000 --- a/documentation/Get-FabricCopyJob.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricCopyJob - -## SYNOPSIS -Retrieves CopyJob details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricCopyJob [-WorkspaceId] [[-CopyJobId] ] [[-CopyJob] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves CopyJob details from a specified workspace using either the provided CopyJobId or CopyJob. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "CopyJob-67890" -This example retrieves the CopyJob details for the CopyJob with ID "CopyJob-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -FabricCopyJob -WorkspaceId "workspace-12345" -CopyJob "My CopyJob" -This example retrieves the CopyJob details for the CopyJob named "My CopyJob" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -CopyJob -The name of the CopyJob to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyJobId -The unique identifier of the CopyJob to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the CopyJob exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricCopyJobDefinition.md b/documentation/Get-FabricCopyJobDefinition.md deleted file mode 100644 index 91e36469..00000000 --- a/documentation/Get-FabricCopyJobDefinition.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricCopyJobDefinition - -## SYNOPSIS -Retrieves the definition of a Copy Job from a specific workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricCopyJobDefinition [-WorkspaceId] [-CopyJobId] [[-CopyJobFormat] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function fetches the Copy Job's content or metadata from a workspace. -It supports both synchronous and asynchronous operations, with detailed logging and error handling. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -``` - -Retrieves the definition of the Copy Job with ID \`67890\` from the workspace with ID \`12345\`. - -## PARAMETERS - -### -CopyJobFormat -(Optional) Specifies the format of the Copy Job definition. -For example, 'json' or 'xml'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyJobId -(Mandatory) The unique identifier of the Copy Job whose definition needs to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace from which the Copy Job definition is to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Handles long-running operations asynchronously. -- Logs detailed information for debugging purposes. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricDashboard.md b/documentation/Get-FabricDashboard.md deleted file mode 100644 index 995502d7..00000000 --- a/documentation/Get-FabricDashboard.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricDashboard - -## SYNOPSIS -Retrieves dashboards from a specified workspace. - -## SYNTAX - -``` -Get-FabricDashboard [-WorkspaceId] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves all dashboards from a specified workspace using the provided WorkspaceId. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricDashboard -WorkspaceId "12345" -This example retrieves all dashboards from the workspace with ID "12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace from which to retrieve dashboards. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricDataPipeline.md b/documentation/Get-FabricDataPipeline.md deleted file mode 100644 index d4be0a29..00000000 --- a/documentation/Get-FabricDataPipeline.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricDataPipeline - -## SYNOPSIS -Retrieves data pipelines from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricDataPipeline [-WorkspaceId] [[-DataPipelineId] ] [[-DataPipelineName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves all data pipelines from a specified workspace using either the provided Data PipelineId or Data PipelineName. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineId "Data Pipeline-67890" -This example retrieves the Data Pipeline details for the Data Pipeline with ID "Data Pipeline-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineName "My Data Pipeline" -This example retrieves the Data Pipeline details for the Data Pipeline named "My Data Pipeline" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -DataPipelineId -The unique identifier of the Data Pipeline to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataPipelineName -The name of the Data Pipeline to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Data Pipeline exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricDatamart.md b/documentation/Get-FabricDatamart.md deleted file mode 100644 index 7df6338b..00000000 --- a/documentation/Get-FabricDatamart.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricDatamart - -## SYNOPSIS -Retrieves datamarts from a specified workspace. - -## SYNTAX - -``` -Get-FabricDatamart [-WorkspaceId] [[-datamartId] ] [[-datamartName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves all datamarts from a specified workspace using the provided WorkspaceId. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricDatamart -WorkspaceId "12345" -This example retrieves all datamarts from the workspace with ID "12345". -``` - -## PARAMETERS - -### -datamartId -The ID of the specific datamart to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -datamartName -The name of the specific datamart to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace from which to retrieve datamarts. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricDomain.md b/documentation/Get-FabricDomain.md deleted file mode 100644 index f80ca3a9..00000000 --- a/documentation/Get-FabricDomain.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricDomain - -## SYNOPSIS -Retrieves domain information from Microsoft Fabric, optionally filtering by domain ID, domain name, or only non-empty domains. - -## SYNTAX - -``` -Get-FabricDomain [[-DomainId] ] [[-DomainName] ] [[-NonEmptyDomainsOnly] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricDomain\` function allows retrieval of domains in Microsoft Fabric, with optional filtering by domain ID or name. -Additionally, it can filter to return only non-empty domains. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricDomain -DomainId "12345" -``` - -Fetches the domain with ID "12345". - -### EXAMPLE 2 -``` -Get-FabricDomain -DomainName "Finance" -``` - -Fetches the domain with the display name "Finance". - -## PARAMETERS - -### -DomainId -(Optional) The ID of the domain to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -(Optional) The display name of the domain to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NonEmptyDomainsOnly -(Optional) If set to \`$true\`, only domains containing workspaces will be returned. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object[] -## 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 diff --git a/documentation/Get-FabricDomainTenantSettingOverrides.md b/documentation/Get-FabricDomainTenantSettingOverrides.md deleted file mode 100644 index bc776af7..00000000 --- a/documentation/Get-FabricDomainTenantSettingOverrides.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricDomainTenantSettingOverrides - -## SYNOPSIS -Retrieves tenant setting overrides for a specific domain or all capacities in the Fabric tenant. - -## SYNTAX - -``` -Get-FabricDomainTenantSettingOverrides [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricDomainTenantSettingOverrides\` function retrieves tenant setting overrides for all domains in the Fabric tenant by making a GET request to the designated API endpoint. -The function ensures token validity before making the request and handles the response appropriately. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricDomainTenantSettingOverrides -``` - -Fetches tenant setting overrides for all domains in the Fabric tenant. - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires the \`$FabricConfig\` global configuration, which must include \`BaseUrl\` and \`FabricHeaders\`. -- Ensures token validity by invoking \`Confirm-TokenState\` before making the API request. -- Logs detailed messages for debugging and error handling. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricDomainWorkspace.md b/documentation/Get-FabricDomainWorkspace.md deleted file mode 100644 index 0c1c503f..00000000 --- a/documentation/Get-FabricDomainWorkspace.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricDomainWorkspace - -## SYNOPSIS -Retrieves the workspaces associated with a specific domain in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricDomainWorkspace [-DomainId] [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricDomainWorkspace\` function fetches the workspaces for the given domain ID. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricDomainWorkspace -DomainId "12345" -``` - -Fetches workspaces for the domain with ID "12345". - -## PARAMETERS - -### -DomainId -The ID of the domain for which to retrieve workspaces. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricEnvironment.md b/documentation/Get-FabricEnvironment.md deleted file mode 100644 index 8bba65bc..00000000 --- a/documentation/Get-FabricEnvironment.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricEnvironment - -## SYNOPSIS -Retrieves an environment or a list of environments from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricEnvironment [-WorkspaceId] [[-EnvironmentId] ] [[-EnvironmentName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricEnvironment\` function sends a GET request to the Fabric API to retrieve environment details for a given workspace. -It can filter the results by \`EnvironmentName\`. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricEnvironment -WorkspaceId "12345" -EnvironmentName "Development" -``` - -Retrieves the "Development" environment from workspace "12345". - -### EXAMPLE 2 -``` -Get-FabricEnvironment -WorkspaceId "12345" -``` - -Retrieves all environments in workspace "12345". - -## PARAMETERS - -### -EnvironmentId -(Optional) The ID of a specific environment to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -(Optional) The name of the specific environment to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace to query environments. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Returns the matching environment details or all environments if no filter is provided. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricEnvironmentLibrary.md b/documentation/Get-FabricEnvironmentLibrary.md deleted file mode 100644 index c0e6b6e7..00000000 --- a/documentation/Get-FabricEnvironmentLibrary.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricEnvironmentLibrary - -## SYNOPSIS -Retrieves the list of libraries associated with a specific environment in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricEnvironmentLibrary [-WorkspaceId] [-EnvironmentId] [-ProgressAction ] - [] -``` - -## DESCRIPTION -The Get-FabricEnvironmentLibrary function fetches library information for a given workspace and environment -using the Microsoft Fabric API. -It ensures the authentication token is valid and validates the response -to handle errors gracefully. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricEnvironmentLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -``` - -Retrieves the libraries associated with the specified environment in the given workspace. - -## PARAMETERS - -### -EnvironmentId -The unique identifier of the environment whose libraries are being queried. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace where the environment is located. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires the \`$FabricConfig\` global object, including \`BaseUrl\` and \`FabricHeaders\`. -- Uses \`Confirm-TokenState\` to validate the token before making API calls. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricEnvironmentSparkCompute.md b/documentation/Get-FabricEnvironmentSparkCompute.md deleted file mode 100644 index 362b7be1..00000000 --- a/documentation/Get-FabricEnvironmentSparkCompute.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricEnvironmentSparkCompute - -## SYNOPSIS -Retrieves the Spark compute details for a specific environment in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricEnvironmentSparkCompute [-WorkspaceId] [-EnvironmentId] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-FabricEnvironmentSparkCompute function communicates with the Microsoft Fabric API to fetch information -about Spark compute resources associated with a specified environment. -It ensures that the API token is valid -and gracefully handles errors during the API call. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricEnvironmentSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -``` - -Retrieves Spark compute details for the specified environment in the given workspace. - -## PARAMETERS - -### -EnvironmentId -The unique identifier of the environment whose Spark compute details are being retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace containing the target environment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires the \`$FabricConfig\` global object, including \`BaseUrl\` and \`FabricHeaders\`. -- Uses \`Confirm-TokenState\` to validate the token before making API calls. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricEnvironmentStagingLibrary.md b/documentation/Get-FabricEnvironmentStagingLibrary.md deleted file mode 100644 index 7abee939..00000000 --- a/documentation/Get-FabricEnvironmentStagingLibrary.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricEnvironmentStagingLibrary - -## SYNOPSIS -Retrieves the staging library details for a specific environment in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricEnvironmentStagingLibrary [-WorkspaceId] [-EnvironmentId] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-FabricEnvironmentStagingLibrary function interacts with the Microsoft Fabric API to fetch information -about staging libraries associated with a specified environment. -It ensures token validity and handles API errors gracefully. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -``` - -Retrieves the staging libraries for the specified environment in the given workspace. - -## PARAMETERS - -### -EnvironmentId -The unique identifier of the environment for which staging library details are being retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace containing the target environment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires the \`$FabricConfig\` global object, including \`BaseUrl\` and \`FabricHeaders\`. -- Uses \`Confirm-TokenState\` to validate the token before making API calls. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricEnvironmentStagingSparkCompute.md b/documentation/Get-FabricEnvironmentStagingSparkCompute.md deleted file mode 100644 index bad5a0d7..00000000 --- a/documentation/Get-FabricEnvironmentStagingSparkCompute.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: -schema: 2.0.0 ---- - -# Get-FabricEnvironmentStagingSparkCompute - -## SYNOPSIS -Retrieves staging Spark compute details for a specific environment in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricEnvironmentStagingSparkCompute [-WorkspaceId] [-EnvironmentId] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-FabricEnvironmentStagingSparkCompute function interacts with the Microsoft Fabric API to fetch information -about staging Spark compute configurations for a specified environment. -It ensures token validity and handles API errors gracefully. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricEnvironmentStagingSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -``` - -Retrieves the staging Spark compute configurations for the specified environment in the given workspace. - -## PARAMETERS - -### -EnvironmentId -The unique identifier of the environment for which staging Spark compute details are being retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace containing the target environment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires the \`$FabricConfig\` global object, including \`BaseUrl\` and \`FabricHeaders\`. -- Uses \`Confirm-TokenState\` to validate the token before making API calls. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricEventhouse.md b/documentation/Get-FabricEventhouse.md deleted file mode 100644 index ef12a22e..00000000 --- a/documentation/Get-FabricEventhouse.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricEventhouse - -## SYNOPSIS -Retrieves Fabric Eventhouses - -## SYNTAX - -``` -Get-FabricEventhouse [-WorkspaceId] [[-EventhouseId] ] [[-EventhouseName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -Retrieves Fabric Eventhouses. -Without the EventhouseName or EventhouseID parameter, all Eventhouses are returned. -If you want to retrieve a specific Eventhouse, you can use the EventhouseName or EventhouseID parameter. -These -parameters cannot be used together. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricEventhouse ` - -WorkspaceId '12345678-1234-1234-1234-123456789012' -``` - -This example will give you all Eventhouses in the Workspace. - -### EXAMPLE 2 -``` -Get-FabricEventhouse ` - -WorkspaceId '12345678-1234-1234-1234-123456789012' ` - -EventhouseName 'MyEventhouse' -``` - -This example will give you all Information about the Eventhouse with the name 'MyEventhouse'. - -### EXAMPLE 3 -``` -Get-FabricEventhouse ` - -WorkspaceId '12345678-1234-1234-1234-123456789012' ` - -EventhouseId '12345678-1234-1234-1234-123456789012' -``` - -This example will give you all Information about the Eventhouse with the Id '12345678-1234-1234-1234-123456789012'. - -### EXAMPLE 4 -``` -Get-FabricEventhouse ` - -WorkspaceId '12345678-1234-1234-1234-123456789012' ` - -EventhouseId '12345678-1234-1234-1234-123456789012' ` - -Verbose -``` - -This example will give you all Information about the Eventhouse with the Id '12345678-1234-1234-1234-123456789012'. -It will also give you verbose output which is useful for debugging. - -## PARAMETERS - -### -EventhouseId -The Id of the Eventhouse to retrieve. -This parameter cannot be used together with EventhouseName. -The value for WorkspaceId is a GUID. -An example of a GUID is '12345678-1234-1234-1234-123456789012'. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventhouseName -The name of the Eventhouse to retrieve. -This parameter cannot be used together with EventhouseID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -Id of the Fabric Workspace for which the Eventhouses should be retrieved. -The value for WorkspaceId is a GUID. -An example of a GUID is '12345678-1234-1234-1234-123456789012'. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -TODO: Add functionality to list all Eventhouses in the subscription. -To do so fetch all workspaces -and then all eventhouses in each workspace. - -Author: Tiago Balabuch - -## RELATED LINKS - -[https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP](https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP) - diff --git a/documentation/Get-FabricEventhouseDefinition.md b/documentation/Get-FabricEventhouseDefinition.md deleted file mode 100644 index f413693e..00000000 --- a/documentation/Get-FabricEventhouseDefinition.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricEventhouseDefinition - -## SYNOPSIS -Retrieves the definition of an Eventhouse from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricEventhouseDefinition [-WorkspaceId] [[-EventhouseId] ] [[-EventhouseFormat] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves the definition of an Eventhouse from a specified workspace using the provided EventhouseId. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -This example retrieves the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhouseFormat "json" -This example retrieves the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" in JSON format. -``` - -## PARAMETERS - -### -EventhouseFormat -The format in which to retrieve the Eventhouse definition. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventhouseId -The unique identifier of the Eventhouse to retrieve the definition for. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Eventhouse exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricEventstream.md b/documentation/Get-FabricEventstream.md deleted file mode 100644 index d037d346..00000000 --- a/documentation/Get-FabricEventstream.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricEventstream - -## SYNOPSIS -Retrieves an Eventstream or a list of Eventstreams from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricEventstream [-WorkspaceId] [[-EventstreamId] ] [[-EventstreamName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -Retrieves Fabric Eventstreams. -Without the EventstreamName or EventstreamID parameter, all Eventstreams are returned. -If you want to retrieve a specific Eventstream, you can use the EventstreamName or EventstreamID parameter. -These -parameters cannot be used together. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricEventstream -WorkspaceId "12345" -EventstreamName "Development" -``` - -Retrieves the "Development" Eventstream from workspace "12345". - -### EXAMPLE 2 -``` -Get-FabricEventstream -WorkspaceId "12345" -``` - -Retrieves all Eventstreams in workspace "12345". - -## PARAMETERS - -### -EventstreamId -The Id of the Eventstream to retrieve. -This parameter cannot be used together with EventstreamName. -The value for EventstreamId is a GUID. -An example of a GUID is '12345678-1234-1234-1234-123456789012'. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventstreamName -(Optional) The name of the specific Eventstream to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace to query Eventstreams. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricEventstreamDefinition.md b/documentation/Get-FabricEventstreamDefinition.md deleted file mode 100644 index 06e46d58..00000000 --- a/documentation/Get-FabricEventstreamDefinition.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricEventstreamDefinition - -## SYNOPSIS -Retrieves the definition of a Eventstream from a specific workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricEventstreamDefinition [-WorkspaceId] [[-EventstreamId] ] [[-EventstreamFormat] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function fetches the Eventstream's content or metadata from a workspace. -Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -``` - -Retrieves the definition of the Eventstream with ID \`67890\` from the workspace with ID \`12345\` in the \`ipynb\` format. - -### EXAMPLE 2 -``` -Get-FabricEventstreamDefinition -WorkspaceId "12345" -``` - -Retrieves the definitions of all Eventstreams in the workspace with ID \`12345\` in the \`ipynb\` format. - -## PARAMETERS - -### -EventstreamFormat -Specifies the format of the Eventstream definition. -Currently, only 'ipynb' is supported. -Default: 'ipynb'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventstreamId -(Optional)The unique identifier of the Eventstream whose definition needs to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace from which the Eventstream definition is to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Handles long-running operations asynchronously. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricExternalDataShares.md b/documentation/Get-FabricExternalDataShares.md deleted file mode 100644 index 6d00efb1..00000000 --- a/documentation/Get-FabricExternalDataShares.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricExternalDataShares - -## SYNOPSIS -Retrieves External Data Shares details from a specified Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricExternalDataShares [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves External Data Shares details. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricExternalDataShares -This example retrieves the External Data Shares details -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricItem.md b/documentation/Get-FabricItem.md deleted file mode 100644 index 896ffd07..00000000 --- a/documentation/Get-FabricItem.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricItem - -## SYNOPSIS -Retrieves fabric items from a workspace. - -## SYNTAX - -### WorkspaceId -``` -Get-FabricItem -WorkspaceId [-type ] [-itemID ] [-ProgressAction ] - [] -``` - -### WorkspaceObject -``` -Get-FabricItem -Workspace [-type ] [-itemID ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -The Get-FabricItem function retrieves fabric items from a specified workspace. -It can retrieve all items or filter them by item type. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricItem -workspaceId "12345" -type "file" -``` - -This example retrieves all fabric items of type "file" from the workspace with ID "12345". - -## PARAMETERS - -### -itemID -The ID of the specific item to retrieve. -If not specified, all items will be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -type -(Optional) The type of the fabric items to retrieve. -If not specified, all items will be retrieved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: itemType - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Workspace -The workspace object from which to retrieve the fabric items. -This parameter can be piped into the function. - -```yaml -Type: System.Object -Parameter Sets: WorkspaceObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace from which to retrieve the fabric items. - -```yaml -Type: System.Guid -Parameter Sets: WorkspaceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Rui Romano - -## RELATED LINKS diff --git a/documentation/Get-FabricKQLDashboard.md b/documentation/Get-FabricKQLDashboard.md deleted file mode 100644 index a8206aa4..00000000 --- a/documentation/Get-FabricKQLDashboard.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricKQLDashboard - -## SYNOPSIS -Retrieves an KQLDashboard or a list of KQLDashboards from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricKQLDashboard [-WorkspaceId] [[-KQLDashboardId] ] [[-KQLDashboardName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricKQLDashboard\` function sends a GET request to the Fabric API to retrieve KQLDashboard details for a given workspace. -It can filter the results by \`KQLDashboardName\`. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricKQLDashboard -WorkspaceId "12345" -KQLDashboardName "Development" -``` - -Retrieves the "Development" KQLDashboard from workspace "12345". - -### EXAMPLE 2 -``` -Get-FabricKQLDashboard -WorkspaceId "12345" -``` - -Retrieves all KQLDashboards in workspace "12345". - -## PARAMETERS - -### -KQLDashboardId -The Id of the KQLDashboard to retrieve. -This parameter cannot be used together with KQLDashboardName. -The value for KQLDashboardID is a GUID. -An example of a GUID is '12345678-1234-1234-1234-123456789012'. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDashboardName -(Optional) The name of the specific KQLDashboard to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace to query KQLDashboards. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricKQLDashboardDefinition.md b/documentation/Get-FabricKQLDashboardDefinition.md deleted file mode 100644 index 5be6cc8e..00000000 --- a/documentation/Get-FabricKQLDashboardDefinition.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricKQLDashboardDefinition - -## SYNOPSIS -Retrieves the definition of a KQLDashboard from a specific workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricKQLDashboardDefinition [-WorkspaceId] [[-KQLDashboardId] ] - [[-KQLDashboardFormat] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function fetches the KQLDashboard's content or metadata from a workspace. -Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -``` - -Retrieves the definition of the KQLDashboard with ID \`67890\` from the workspace with ID \`12345\` in the \`ipynb\` format. - -### EXAMPLE 2 -``` -Get-FabricKQLDashboardDefinition -WorkspaceId "12345" -``` - -Retrieves the definitions of all KQLDashboards in the workspace with ID \`12345\` in the \`ipynb\` format. - -## PARAMETERS - -### -KQLDashboardFormat -Specifies the format of the KQLDashboard definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDashboardId -(Optional)The unique identifier of the KQLDashboard whose definition needs to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace from which the KQLDashboard definition is to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Handles long-running operations asynchronously. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricKQLDatabase.md b/documentation/Get-FabricKQLDatabase.md deleted file mode 100644 index 6c5c1698..00000000 --- a/documentation/Get-FabricKQLDatabase.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricKQLDatabase - -## SYNOPSIS -Retrieves an KQLDatabase or a list of KQLDatabases from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricKQLDatabase [-WorkspaceId] [[-KQLDatabaseId] ] [[-KQLDatabaseName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricKQLDatabase\` function sends a GET request to the Fabric API to retrieve KQLDatabase details for a given workspace. -It can filter the results by \`KQLDatabaseName\`. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricKQLDatabase -WorkspaceId "12345" -KQLDatabaseName "Development" -``` - -Retrieves the "Development" KQLDatabase from workspace "12345". - -### EXAMPLE 2 -``` -Get-FabricKQLDatabase -WorkspaceId "12345" -``` - -Retrieves all KQLDatabases in workspace "12345". - -## PARAMETERS - -### -KQLDatabaseId -(Optional) The ID of a specific KQLDatabase to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabaseName -(Optional) The name of the specific KQLDatabase to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace to query KQLDatabases. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricKQLDatabaseDefinition.md b/documentation/Get-FabricKQLDatabaseDefinition.md deleted file mode 100644 index a78c56f9..00000000 --- a/documentation/Get-FabricKQLDatabaseDefinition.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricKQLDatabaseDefinition - -## SYNOPSIS -Retrieves the definition of a KQLDatabase from a specific workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricKQLDatabaseDefinition [-WorkspaceId] [[-KQLDatabaseId] ] [[-KQLDatabaseFormat] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function fetches the KQLDatabase's content or metadata from a workspace. -It supports retrieving KQLDatabase definitions in the Jupyter KQLDatabase (\`ipynb\`) format. -Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" -``` - -Retrieves the definition of the KQLDatabase with ID \`67890\` from the workspace with ID \`12345\` in the \`ipynb\` format. - -### EXAMPLE 2 -``` -Get-FabricKQLDatabaseDefinition -WorkspaceId "12345" -``` - -Retrieves the definitions of all KQLDatabases in the workspace with ID \`12345\` in the \`ipynb\` format. - -## PARAMETERS - -### -KQLDatabaseFormat -Specifies the format of the KQLDatabase definition. -Currently, only 'ipynb' is supported. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabaseId -(Optional)The unique identifier of the KQLDatabase whose definition needs to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace from which the KQLDatabase definition is to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Handles long-running operations asynchronously. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricKQLQueryset.md b/documentation/Get-FabricKQLQueryset.md deleted file mode 100644 index 7c5b2470..00000000 --- a/documentation/Get-FabricKQLQueryset.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricKQLQueryset - -## SYNOPSIS -Retrieves an KQLQueryset or a list of KQLQuerysets from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricKQLQueryset [-WorkspaceId] [[-KQLQuerysetId] ] [[-KQLQuerysetName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricKQLQueryset\` function sends a GET request to the Fabric API to retrieve KQLQueryset details for a given workspace. -It can filter the results by \`KQLQuerysetName\`. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricKQLQueryset -WorkspaceId "12345" -KQLQuerysetName "Development" -``` - -Retrieves the "Development" KQLQueryset from workspace "12345". - -### EXAMPLE 2 -``` -Get-FabricKQLQueryset -WorkspaceId "12345" -``` - -Retrieves all KQLQuerysets in workspace "12345". - -## PARAMETERS - -### -KQLQuerysetId -(Optional) The ID of a specific KQLQueryset to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLQuerysetName -(Optional) The name of the specific KQLQueryset to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace to query KQLQuerysets. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricKQLQuerysetDefinition.md b/documentation/Get-FabricKQLQuerysetDefinition.md deleted file mode 100644 index 1904020a..00000000 --- a/documentation/Get-FabricKQLQuerysetDefinition.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricKQLQuerysetDefinition - -## SYNOPSIS -Retrieves the definition of a KQLQueryset from a specific workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricKQLQuerysetDefinition [-WorkspaceId] [[-KQLQuerysetId] ] [[-KQLQuerysetFormat] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function fetches the KQLQueryset's content or metadata from a workspace. -Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" -``` - -Retrieves the definition of the KQLQueryset with ID \`67890\` from the workspace with ID \`12345\` in the \`ipynb\` format. - -### EXAMPLE 2 -``` -Get-FabricKQLQuerysetDefinition -WorkspaceId "12345" -``` - -Retrieves the definitions of all KQLQuerysets in the workspace with ID \`12345\` in the \`ipynb\` format. - -## PARAMETERS - -### -KQLQuerysetFormat -Specifies the format of the KQLQueryset definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLQuerysetId -(Optional)The unique identifier of the KQLQueryset whose definition needs to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace from which the KQLQueryset definition is to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Handles long-running operations asynchronously. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricLakehouse.md b/documentation/Get-FabricLakehouse.md deleted file mode 100644 index 20f803e0..00000000 --- a/documentation/Get-FabricLakehouse.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricLakehouse - -## SYNOPSIS -Retrieves an Lakehouse or a list of Lakehouses from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricLakehouse [-WorkspaceId] [[-LakehouseId] ] [[-LakehouseName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricLakehouse\` function sends a GET request to the Fabric API to retrieve Lakehouse details for a given workspace. -It can filter the results by \`LakehouseName\`. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricLakehouse -WorkspaceId "12345" -LakehouseName "Development" -``` - -Retrieves the "Development" Lakehouse from workspace "12345". - -### EXAMPLE 2 -``` -Get-FabricLakehouse -WorkspaceId "12345" -``` - -Retrieves all Lakehouses in workspace "12345". - -## PARAMETERS - -### -LakehouseId -(Optional) The ID of a specific Lakehouse to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LakehouseName -(Optional) The name of the specific Lakehouse to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace to query Lakehouses. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricLakehouseTable.md b/documentation/Get-FabricLakehouseTable.md deleted file mode 100644 index a6743e33..00000000 --- a/documentation/Get-FabricLakehouseTable.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricLakehouseTable - -## SYNOPSIS -Retrieves tables from a specified Lakehouse in a Fabric workspace. - -## SYNTAX - -``` -Get-FabricLakehouseTable [-WorkspaceId] [[-LakehouseId] ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -This function retrieves tables from a specified Lakehouse in a Fabric workspace. -It handles pagination using a continuation token to ensure all data is retrieved. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricLakehouseTable -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -This example retrieves all tables from the specified Lakehouse in the specified workspace. -``` - -## PARAMETERS - -### -LakehouseId -The ID of the Lakehouse from which to retrieve tables. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace containing the Lakehouse. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object[] -## NOTES -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricLongRunningOperation.md b/documentation/Get-FabricLongRunningOperation.md deleted file mode 100644 index ee959fd7..00000000 --- a/documentation/Get-FabricLongRunningOperation.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricLongRunningOperation - -## SYNOPSIS -Monitors the status of a long-running operation in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricLongRunningOperation [[-OperationId] ] [[-Location] ] [[-RetryAfter] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-FabricLongRunningOperation function queries the Microsoft Fabric API to check the status of a -long-running operation. -It periodically polls the operation until it reaches a terminal state (Succeeded or Failed). - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricLongRunningOperation -operationId "12345-abcd-67890-efgh" -retryAfter 10 -``` - -This command polls the status of the operation with the given operationId every 10 seconds until it completes. - -## PARAMETERS - -### -Location -The URL provided in the Location header of the initial request. -This is used to check the status of the operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationId -The unique identifier of the long-running operation to be monitored. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryAfter -The interval (in seconds) to wait between polling the operation status. -The default is 5 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: 5 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricLongRunningOperationResult.md b/documentation/Get-FabricLongRunningOperationResult.md deleted file mode 100644 index a75108ff..00000000 --- a/documentation/Get-FabricLongRunningOperationResult.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricLongRunningOperationResult - -## SYNOPSIS -Retrieves the result of a completed long-running operation from the Microsoft Fabric API. - -## SYNTAX - -``` -Get-FabricLongRunningOperationResult [-OperationId] [-ProgressAction ] - [] -``` - -## DESCRIPTION -The Get-FabricLongRunningOperationResult function queries the Microsoft Fabric API to fetch the result -of a specific long-running operation. -This is typically used after confirming the operation has completed successfully. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricLongRunningOperationResult -operationId "12345-abcd-67890-efgh" -``` - -This command fetches the result of the operation with the specified operationId. - -## PARAMETERS - -### -OperationId -The unique identifier of the completed long-running operation whose result you want to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Ensure the Fabric API headers (e.g., authorization tokens) are defined in $FabricConfig.FabricHeaders. -- This function does not handle polling. Ensure the operation is in a terminal state before calling this function. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricMLExperiment.md b/documentation/Get-FabricMLExperiment.md deleted file mode 100644 index 68433c5d..00000000 --- a/documentation/Get-FabricMLExperiment.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricMLExperiment - -## SYNOPSIS -Retrieves ML Experiment details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricMLExperiment [-WorkspaceId] [[-MLExperimentId] ] [[-MLExperimentName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves ML Experiment details from a specified workspace using either the provided MLExperimentId or MLExperimentName. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" -This example retrieves the ML Experiment details for the experiment with ID "experiment-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentName "My ML Experiment" -This example retrieves the ML Experiment details for the experiment named "My ML Experiment" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -MLExperimentId -The unique identifier of the ML Experiment to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MLExperimentName -The name of the ML Experiment to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the ML Experiment exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricMLModel.md b/documentation/Get-FabricMLModel.md deleted file mode 100644 index b3bbdade..00000000 --- a/documentation/Get-FabricMLModel.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricMLModel - -## SYNOPSIS -Retrieves ML Model details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricMLModel [-WorkspaceId] [[-MLModelId] ] [[-MLModelName] ] - [-ProgressAction ] [] -``` - -## 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 -``` -Get-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" -This example retrieves the ML Model details for the model with ID "model-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricMLModel -WorkspaceId "workspace-12345" -MLModelName "My ML Model" -This example retrieves the ML Model details for the model named "My ML Model" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -MLModelId -The unique identifier of the ML Model to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MLModelName -The name of the ML Model to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the ML Model exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricMirroredDatabase.md b/documentation/Get-FabricMirroredDatabase.md deleted file mode 100644 index f8333b71..00000000 --- a/documentation/Get-FabricMirroredDatabase.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricMirroredDatabase - -## SYNOPSIS -Retrieves an MirroredDatabase or a list of MirroredDatabases from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricMirroredDatabase [-WorkspaceId] [[-MirroredDatabaseId] ] - [[-MirroredDatabaseName] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricMirroredDatabase\` function sends a GET request to the Fabric API to retrieve MirroredDatabase details for a given workspace. -It can filter the results by \`MirroredDatabaseName\`. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricMirroredDatabase -WorkspaceId "12345" -MirroredDatabaseName "Development" -``` - -Retrieves the "Development" MirroredDatabase from workspace "12345". - -### EXAMPLE 2 -``` -Get-FabricMirroredDatabase -WorkspaceId "12345" -``` - -Retrieves all MirroredDatabases in workspace "12345". - -## PARAMETERS - -### -MirroredDatabaseId -(Optional) The ID of a specific MirroredDatabase to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MirroredDatabaseName -(Optional) The name of the specific MirroredDatabase to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace to query MirroredDatabases. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricMirroredDatabaseDefinition.md b/documentation/Get-FabricMirroredDatabaseDefinition.md deleted file mode 100644 index 49ef63ed..00000000 --- a/documentation/Get-FabricMirroredDatabaseDefinition.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricMirroredDatabaseDefinition - -## SYNOPSIS -Retrieves the definition of a MirroredDatabase from a specific workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricMirroredDatabaseDefinition [-WorkspaceId] [[-MirroredDatabaseId] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function fetches the MirroredDatabase's content or metadata from a workspace. -Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" -``` - -Retrieves the definition of the MirroredDatabase with ID \`67890\` from the workspace with ID \`12345\`. - -### EXAMPLE 2 -``` -Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -``` - -Retrieves the definitions of all MirroredDatabases in the workspace with ID \`12345\`. - -## PARAMETERS - -### -MirroredDatabaseId -(Optional)The unique identifier of the MirroredDatabase whose definition needs to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace from which the MirroredDatabase definition is to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Handles long-running operations asynchronously. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricMirroredDatabaseStatus.md b/documentation/Get-FabricMirroredDatabaseStatus.md deleted file mode 100644 index cb320471..00000000 --- a/documentation/Get-FabricMirroredDatabaseStatus.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricMirroredDatabaseStatus - -## SYNOPSIS -Retrieves the status of a mirrored database in a specified workspace. - -## SYNTAX - -``` -Get-FabricMirroredDatabaseStatus [-WorkspaceId] [[-MirroredDatabaseId] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -Retrieves the status of a mirrored database in a specified workspace. -The function validates the authentication token, constructs the API endpoint URL, and makes a POST request to retrieve the mirroring status. -It handles errors and logs messages at various levels (Debug, Error). - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricMirroredDatabaseStatus -WorkspaceId "your-workspace-id" -MirroredDatabaseId "your-mirrored-database-id" -This example retrieves the status of a mirrored database with the specified ID in the specified workspace. -``` - -## PARAMETERS - -### -MirroredDatabaseId -the ID of the mirrored database whose status is to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace containing the mirrored database. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricMirroredWarehouse.md b/documentation/Get-FabricMirroredWarehouse.md deleted file mode 100644 index 75ed3e6a..00000000 --- a/documentation/Get-FabricMirroredWarehouse.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricMirroredWarehouse - -## SYNOPSIS -Retrieves an MirroredWarehouse or a list of MirroredWarehouses from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricMirroredWarehouse [-WorkspaceId] [[-MirroredWarehouseId] ] - [[-MirroredWarehouseName] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricMirroredWarehouse\` function sends a GET request to the Fabric API to retrieve MirroredWarehouse details for a given workspace. -It can filter the results by \`MirroredWarehouseName\`. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricMirroredWarehouse -WorkspaceId "12345" -MirroredWarehouseName "Development" -``` - -Retrieves the "Development" MirroredWarehouse from workspace "12345". - -### EXAMPLE 2 -``` -Get-FabricMirroredWarehouse -WorkspaceId "12345" -``` - -Retrieves all MirroredWarehouses in workspace "12345". - -## PARAMETERS - -### -MirroredWarehouseId -(Optional) The ID of a specific MirroredWarehouse to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MirroredWarehouseName -(Optional) The name of the specific MirroredWarehouse to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace to query MirroredWarehouses. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricNotebook.md b/documentation/Get-FabricNotebook.md deleted file mode 100644 index 5e34b3c6..00000000 --- a/documentation/Get-FabricNotebook.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricNotebook - -## SYNOPSIS -Retrieves an Notebook or a list of Notebooks from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricNotebook [-WorkspaceId] [[-NotebookId] ] [[-NotebookName] ] - [-ProgressAction ] [] -``` - -## 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 -``` -Get-FabricNotebook -WorkspaceId "12345" -NotebookName "Development" -``` - -Retrieves the "Development" Notebook from workspace "12345". - -### EXAMPLE 2 -``` -Get-FabricNotebook -WorkspaceId "12345" -``` - -Retrieves all Notebooks in workspace "12345". - -## PARAMETERS - -### -NotebookId -(Optional) The ID of a specific Notebook to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookName -(Optional) The name of the specific Notebook to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace to query Notebooks. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricNotebookDefinition.md b/documentation/Get-FabricNotebookDefinition.md deleted file mode 100644 index 85014e02..00000000 --- a/documentation/Get-FabricNotebookDefinition.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricNotebookDefinition - -## SYNOPSIS -Retrieves the definition of a notebook from a specific workspace in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricNotebookDefinition [-WorkspaceId] [[-NotebookId] ] [[-NotebookFormat] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function fetches the notebook's content or metadata from a workspace. -It supports retrieving notebook definitions in the Jupyter Notebook (\`ipynb\`) format. -Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" -``` - -Retrieves the definition of the notebook with ID \`67890\` from the workspace with ID \`12345\` in the \`ipynb\` format. - -### EXAMPLE 2 -``` -Get-FabricNotebookDefinition -WorkspaceId "12345" -``` - -Retrieves the definitions of all notebooks in the workspace with ID \`12345\` in the \`ipynb\` format. - -## PARAMETERS - -### -NotebookFormat -Specifies the format of the notebook definition. -Currently, only 'ipynb' is supported. -Default: 'ipynb'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: Ipynb -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookId -(Optional)The unique identifier of the notebook whose definition needs to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace from which the notebook definition is to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Handles long-running operations asynchronously. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricPaginatedReport.md b/documentation/Get-FabricPaginatedReport.md deleted file mode 100644 index 3ac2f151..00000000 --- a/documentation/Get-FabricPaginatedReport.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricPaginatedReport - -## SYNOPSIS -Retrieves paginated report details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricPaginatedReport [-WorkspaceId] [[-PaginatedReportId] ] [[-PaginatedReportName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves paginated report details from a specified workspace using either the provided PaginatedReportId or PaginatedReportName. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricPaginatedReports -WorkspaceId "workspace-12345" -PaginatedReportId "report-67890" -This example retrieves the paginated report details for the report with ID "report-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricPaginatedReports -WorkspaceId "workspace-12345" -PaginatedReportName "My Paginated Report" -This example retrieves the paginated report details for the report named "My Paginated Report" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -PaginatedReportId -The unique identifier of the paginated report to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PaginatedReportName -The name of the paginated report to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the paginated reports exist. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricRecoveryPoint.md b/documentation/Get-FabricRecoveryPoint.md deleted file mode 100644 index 77677615..00000000 --- a/documentation/Get-FabricRecoveryPoint.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricRecoveryPoint - -## SYNOPSIS -Get a list of Fabric recovery points. - -## SYNTAX - -``` -Get-FabricRecoveryPoint [[-WorkspaceGUID] ] [[-DataWarehouseGUID] ] [[-BaseUrl] ] - [[-Since] ] [[-Type] ] [[-CreateTime] ] -``` - -## DESCRIPTION -Get a list of Fabric recovery points. -Results can be filter by date or type. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricRecoveryPoint -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -``` - -Gets all the available recovery points for the specified data warehouse, in the specified workspace. - -## PARAMETERS - -### -BaseUrl -Defaults to api.powerbi.com - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: Api.powerbi.com -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateTime -The specific unique time of the restore point to remove. -Get this from Get-FabricRecoveryPoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataWarehouseGUID -The GUID for the data warehouse which we want to retrieve restore points for. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Since -Filter the results to only include restore points created after this date. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Filter the results to only include restore points of this type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceGUID -This is the workspace GUID in which the data warehouse resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES -Based on API calls from this blog post: https://blog.fabric.microsoft.com/en-US/blog/the-art-of-data-warehouse-recovery-within-microsoft-fabric/ - -Author: Jess Pomfret - -## RELATED LINKS diff --git a/documentation/Get-FabricReflex.md b/documentation/Get-FabricReflex.md deleted file mode 100644 index 9eb7a645..00000000 --- a/documentation/Get-FabricReflex.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricReflex - -## SYNOPSIS -Retrieves Reflex details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricReflex [-WorkspaceId] [[-ReflexId] ] [[-ReflexName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves Reflex details from a specified workspace using either the provided ReflexId or ReflexName. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -This example retrieves the Reflex details for the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricReflex -WorkspaceId "workspace-12345" -ReflexName "My Reflex" -This example retrieves the Reflex details for the Reflex named "My Reflex" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexId -The unique identifier of the Reflex to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexName -The name of the Reflex to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Reflex exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricReflexDefinition.md b/documentation/Get-FabricReflexDefinition.md deleted file mode 100644 index 47ce83d6..00000000 --- a/documentation/Get-FabricReflexDefinition.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricReflexDefinition - -## SYNOPSIS -Retrieves the definition of an Reflex from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricReflexDefinition [-WorkspaceId] [[-ReflexId] ] [[-ReflexFormat] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves the definition of an Reflex from a specified workspace using the provided ReflexId. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -This example retrieves the definition of the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexFormat "json" -This example retrieves the definition of the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345" in JSON format. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexFormat -The format in which to retrieve the Reflex definition. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexId -The unique identifier of the Reflex to retrieve the definition for. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Reflex exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricReport.md b/documentation/Get-FabricReport.md deleted file mode 100644 index 9e41c82b..00000000 --- a/documentation/Get-FabricReport.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricReport - -## SYNOPSIS -Retrieves Report details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricReport [-WorkspaceId] [[-ReportId] ] [[-ReportName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves Report details from a specified workspace using either the provided ReportId or ReportName. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" -This example retrieves the Report details for the Report with ID "Report-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricReport -WorkspaceId "workspace-12345" -ReportName "My Report" -This example retrieves the Report details for the Report named "My Report" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportId -The unique identifier of the Report to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportName -The name of the Report to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Report exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricReportDefinition.md b/documentation/Get-FabricReportDefinition.md deleted file mode 100644 index 5fa99c31..00000000 --- a/documentation/Get-FabricReportDefinition.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricReportDefinition - -## SYNOPSIS -Retrieves the definition of an Report from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricReportDefinition [-WorkspaceId] [[-ReportId] ] [[-ReportFormat] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves the definition of an Report from a specified workspace using the provided ReportId. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" -This example retrieves the definition of the Report with ID "Report-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportFormat "json" -This example retrieves the definition of the Report with ID "Report-67890" in the workspace with ID "workspace-12345" in JSON format. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFormat -The format in which to retrieve the Report definition. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportId -The unique identifier of the Report to retrieve the definition for. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Report exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricSQLEndpoint.md b/documentation/Get-FabricSQLEndpoint.md deleted file mode 100644 index 493475a5..00000000 --- a/documentation/Get-FabricSQLEndpoint.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricSQLEndpoint - -## SYNOPSIS -Retrieves SQL Endpoints from a specified workspace in Fabric. - -## SYNTAX - -``` -Get-FabricSQLEndpoint [-WorkspaceId] [[-SQLEndpointId] ] [[-SQLEndpointName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-FabricSQLEndpoint function retrieves SQL Endpoints from a specified workspace in Fabric. -It supports filtering by SQL Endpoint ID or SQL Endpoint Name. -If both filters are provided, -an error message is returned. -The function handles token validation, API requests with continuation -tokens, and processes the response to return the desired SQL Endpoint(s). - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointId "endpoint456" -``` - -### EXAMPLE 2 -``` -Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointName "MySQLEndpoint" -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SQLEndpointId -The ID of the SQL Endpoint to retrieve. -This parameter is optional but cannot be used together with SQLEndpointName. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SQLEndpointName -The name of the SQL Endpoint to retrieve. -This parameter is optional but cannot be used together with SQLEndpointId. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace from which to retrieve SQL Endpoints. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- This function requires the FabricConfig object to be properly configured with BaseUrl and FabricHeaders. -- The function uses continuation tokens to handle paginated API responses. -- If no filter parameters are provided, all SQL Endpoints in the specified workspace are returned. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricSemanticModel.md b/documentation/Get-FabricSemanticModel.md deleted file mode 100644 index a267f235..00000000 --- a/documentation/Get-FabricSemanticModel.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricSemanticModel - -## SYNOPSIS -Retrieves SemanticModel details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricSemanticModel [-WorkspaceId] [[-SemanticModelId] ] [[-SemanticModelName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves SemanticModel details from a specified workspace using either the provided SemanticModelId or SemanticModelName. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -This example retrieves the SemanticModel details for the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelName "My SemanticModel" -This example retrieves the SemanticModel details for the SemanticModel named "My SemanticModel" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelId -The unique identifier of the SemanticModel to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelName -The name of the SemanticModel to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SemanticModel exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricSemanticModelDefinition.md b/documentation/Get-FabricSemanticModelDefinition.md deleted file mode 100644 index 3ee4940d..00000000 --- a/documentation/Get-FabricSemanticModelDefinition.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricSemanticModelDefinition - -## SYNOPSIS -Retrieves the definition of an SemanticModel from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricSemanticModelDefinition [-WorkspaceId] [[-SemanticModelId] ] - [[-SemanticModelFormat] ] [-ProgressAction ] [] -``` - -## 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 -``` -Get-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -This example retrieves the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelFormat "json" -This example retrieves the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" in JSON format. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelFormat -The format in which to retrieve the SemanticModel definition. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: TMDL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelId -The unique identifier of the SemanticModel to retrieve the definition for. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SemanticModel exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricSparkJobDefinition.md b/documentation/Get-FabricSparkJobDefinition.md deleted file mode 100644 index b7749d31..00000000 --- a/documentation/Get-FabricSparkJobDefinition.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricSparkJobDefinition - -## SYNOPSIS -Retrieves Spark Job Definition details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricSparkJobDefinition [-WorkspaceId] [[-SparkJobDefinitionId] ] - [[-SparkJobDefinitionName] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves SparkJobDefinition details from a specified workspace using either the provided SparkJobDefinitionId or SparkJobDefinitionName. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -This example retrieves the SparkJobDefinition details for the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionName "My SparkJobDefinition" -This example retrieves the SparkJobDefinition details for the SparkJobDefinition named "My SparkJobDefinition" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionId -The unique identifier of the SparkJobDefinition to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionName -The name of the SparkJobDefinition to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SparkJobDefinition exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricSparkJobDefinitionDefinition.md b/documentation/Get-FabricSparkJobDefinitionDefinition.md deleted file mode 100644 index 735b0168..00000000 --- a/documentation/Get-FabricSparkJobDefinitionDefinition.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricSparkJobDefinitionDefinition - -## SYNOPSIS -Retrieves the definition of an SparkJobDefinition from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricSparkJobDefinitionDefinition [-WorkspaceId] [[-SparkJobDefinitionId] ] - [[-SparkJobDefinitionFormat] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves the definition of an SparkJobDefinition from a specified workspace using the provided SparkJobDefinitionId. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -This example retrieves the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionFormat "json" -This example retrieves the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" in JSON format. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionFormat -The format in which to retrieve the SparkJobDefinition definition. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: SparkJobDefinitionV1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionId -The unique identifier of the SparkJobDefinition to retrieve the definition for. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SparkJobDefinition exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricSparkSettings.md b/documentation/Get-FabricSparkSettings.md deleted file mode 100644 index 433d3fa8..00000000 --- a/documentation/Get-FabricSparkSettings.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricSparkSettings - -## SYNOPSIS -Retrieves Spark settings from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricSparkSettings [-WorkspaceId] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves Spark settings from a specified workspace using the provided WorkspaceId. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricSparkSettings -WorkspaceId "workspace-12345" -This example retrieves the Spark settings for the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which to retrieve Spark settings. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object[] -## 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 diff --git a/documentation/Get-FabricTenantSetting.md b/documentation/Get-FabricTenantSetting.md deleted file mode 100644 index cce89c68..00000000 --- a/documentation/Get-FabricTenantSetting.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricTenantSetting - -## SYNOPSIS -Retrieves tenant settings from the Fabric environment. - -## SYNTAX - -``` -Get-FabricTenantSetting [[-SettingTitle] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricTenantSetting\` function retrieves tenant settings for a Fabric environment by making a GET request to the appropriate API endpoint. -Optionally, it filters the results by the \`SettingTitle\` parameter. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricTenantSetting -``` - -Returns all tenant settings. - -### EXAMPLE 2 -``` -Get-FabricTenantSetting -SettingTitle "SomeSetting" -``` - -Returns the tenant setting with the title "SomeSetting". - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingTitle -(Optional) The title of a specific tenant setting to filter the results. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Is-TokenExpired\` to ensure token validity before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricUsageMetricsQuery.md b/documentation/Get-FabricUsageMetricsQuery.md deleted file mode 100644 index f36d8466..00000000 --- a/documentation/Get-FabricUsageMetricsQuery.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricUsageMetricsQuery - -## SYNOPSIS -Retrieves usage metrics for a specific dataset. - -## SYNTAX - -``` -Get-FabricUsageMetricsQuery [-DatasetID] [-groupId] [-reportname] - [[-ImpersonatedUser] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-FabricUsageMetricsQuery function retrieves usage metrics for a specific dataset. -It supports multiple aliases for flexibility. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricUsageMetricsQuery -DatasetID "your-dataset-id" -groupId "your-group-id" -reportname "your-report-name" -token "your-token" -``` - -This example retrieves the usage metrics for a specific dataset given the dataset ID, group ID, report name, and token. - -## PARAMETERS - -### -DatasetID -The ID of the dataset. -This is a mandatory parameter. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -groupId -The ID of the group. -This is a mandatory parameter. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImpersonatedUser -The name of the impersonated user. -This is an optional parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -reportname -The name of the report. -This is a mandatory parameter. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -The function defines the headers and body for a POST request to the PowerBI API to retrieve the usage metrics for the specified dataset. -It then makes the POST request and returns the response. - -Author: Ioana Bouariu - -## RELATED LINKS diff --git a/documentation/Get-FabricUserListAccessEntities.md b/documentation/Get-FabricUserListAccessEntities.md deleted file mode 100644 index 84c3521a..00000000 --- a/documentation/Get-FabricUserListAccessEntities.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricUserListAccessEntities - -## SYNOPSIS -Retrieves access entities for a specified user in Microsoft Fabric. - -## SYNTAX - -``` -Get-FabricUserListAccessEntities [-UserId] [[-Type] ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -This function retrieves a list of access entities associated with a specified user in Microsoft Fabric. -It supports filtering by entity type and handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricUserListAccessEntities -UserId "user-12345" -This example retrieves all access entities associated with the user having ID "user-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricUserListAccessEntities -UserId "user-12345" -Type "Dashboard" -This example retrieves only the 'Dashboard' access entities associated with the user having ID "user-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The type of access entity to filter the results by. -This parameter is optional and supports predefined values such as 'CopyJob', 'Dashboard', 'DataPipeline', etc. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The unique identifier of the user whose access entities are to be retrieved. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricWarehouse.md b/documentation/Get-FabricWarehouse.md deleted file mode 100644 index 8027cae2..00000000 --- a/documentation/Get-FabricWarehouse.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricWarehouse - -## SYNOPSIS -Retrieves warehouse details from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Get-FabricWarehouse [-WorkspaceId] [[-WarehouseId] ] [[-WarehouseName] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves warehouse details from a specified workspace using either the provided WarehouseId or WarehouseName. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" -This example retrieves the warehouse details for the warehouse with ID "warehouse-67890" in the workspace with ID "workspace-12345". -``` - -### EXAMPLE 2 -``` -Get-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseName "My Warehouse" -This example retrieves the warehouse details for the warehouse named "My Warehouse" in the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarehouseId -The unique identifier of the warehouse to retrieve. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarehouseName -The name of the warehouse to retrieve. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the warehouse exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricWorkspace.md b/documentation/Get-FabricWorkspace.md deleted file mode 100644 index 69729101..00000000 --- a/documentation/Get-FabricWorkspace.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricWorkspace - -## SYNOPSIS -Retrieves details of a Microsoft Fabric workspace by its ID or name. - -## SYNTAX - -``` -Get-FabricWorkspace [[-WorkspaceId] ] [[-WorkspaceName] ] [-ProgressAction ] - [] -``` - -## DESCRIPTION -The \`Get-FabricWorkspace\` function fetches workspace details from the Fabric API. -It supports filtering by WorkspaceId or WorkspaceName. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricWorkspace -WorkspaceId "workspace123" -``` - -Fetches details of the workspace with ID "workspace123". - -### EXAMPLE 2 -``` -Get-FabricWorkspace -WorkspaceName "MyWorkspace" -``` - -Fetches details of the workspace with the name "MyWorkspace". - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceName -The display name of the workspace to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Returns the matching workspace details or all workspaces if no filter is provided. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Get-FabricWorkspaceDatasetRefreshes.md b/documentation/Get-FabricWorkspaceDatasetRefreshes.md deleted file mode 100644 index b6d1e836..00000000 --- a/documentation/Get-FabricWorkspaceDatasetRefreshes.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricWorkspaceDatasetRefreshes - -## SYNOPSIS -Retrieves the refresh history of all datasets in a specified PowerBI workspace. - -## SYNTAX - -``` -Get-FabricWorkspaceDatasetRefreshes [-WorkspaceID] [-ProgressAction ] - [] -``` - -## DESCRIPTION -The Get-FabricWorkspaceDatasetRefreshes function uses the PowerBI cmdlets to retrieve the refresh history of all datasets in a specified workspace. -It uses the workspace ID to get the workspace and its datasets, and then retrieves the refresh history for each dataset. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricWorkspaceDatasetRefreshes -WorkspaceID "12345678-90ab-cdef-1234-567890abcdef" -``` - -This command retrieves the refresh history of all datasets in the workspace with the specified ID. - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceID -The ID of the PowerBI workspace. -This is a mandatory parameter. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String. You can pipe a string that contains the workspace ID to Get-FabricWorkspaceDatasetRefreshes. -## OUTPUTS - -### Array. Get-FabricWorkspaceDatasetRefreshes returns an array of refresh history objects. -## NOTES -Alias: Get-PowerBIWorkspaceDatasetRefreshes, Get-FabWorkspaceDatasetRefreshes - -Author: Ioana Bouariu - -## RELATED LINKS diff --git a/documentation/Get-FabricWorkspaceRoleAssignment.md b/documentation/Get-FabricWorkspaceRoleAssignment.md deleted file mode 100644 index 57378197..00000000 --- a/documentation/Get-FabricWorkspaceRoleAssignment.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricWorkspaceRoleAssignment - -## SYNOPSIS -Retrieves role assignments for a specified Fabric workspace. - -## SYNTAX - -``` -Get-FabricWorkspaceRoleAssignment [-WorkspaceId] [[-WorkspaceRoleAssignmentId] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricWorkspaceRoleAssignments\` function fetches the role assignments associated with a Fabric workspace by making a GET request to the API. -If \`WorkspaceRoleAssignmentId\` is provided, it retrieves the specific role assignment. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricWorkspaceRoleAssignments -WorkspaceId "workspace123" -``` - -Fetches all role assignments for the workspace with the ID "workspace123". - -### EXAMPLE 2 -``` -Get-FabricWorkspaceRoleAssignments -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "role123" -``` - -Fetches the role assignment with the ID "role123" for the workspace "workspace123". - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace to fetch role assignments for. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceRoleAssignmentId -(Optional) The unique identifier of a specific role assignment to retrieve. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object[] -## 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 diff --git a/documentation/Get-FabricWorkspaceTenantSettingOverrides.md b/documentation/Get-FabricWorkspaceTenantSettingOverrides.md deleted file mode 100644 index cf16773a..00000000 --- a/documentation/Get-FabricWorkspaceTenantSettingOverrides.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricWorkspaceTenantSettingOverrides - -## SYNOPSIS -Retrieves tenant setting overrides for all workspaces in the Fabric tenant. - -## SYNTAX - -``` -Get-FabricWorkspaceTenantSettingOverrides [-ProgressAction ] [] -``` - -## DESCRIPTION -The \`Get-FabricWorkspaceTenantSettingOverrides\` function retrieves tenant setting overrides for all workspaces in the Fabric tenant by making a GET request to the appropriate API endpoint. -The function validates the authentication token before making the request and handles the response accordingly. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricWorkspaceTenantSettingOverrides -``` - -Returns all workspaces tenant setting overrides. - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Get-FabricWorkspaceUsageMetricsData.md b/documentation/Get-FabricWorkspaceUsageMetricsData.md deleted file mode 100644 index 8de8921a..00000000 --- a/documentation/Get-FabricWorkspaceUsageMetricsData.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Get-FabricWorkspaceUsageMetricsData - -## SYNOPSIS -Retrieves workspace usage metrics data. - -## SYNTAX - -``` -Get-FabricWorkspaceUsageMetricsData [-WorkspaceId] [[-username] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The Get-FabricWorkspaceUsageMetricsData function retrieves workspace usage metrics. -It supports multiple aliases for flexibility. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricWorkspaceUsageMetricsData -workspaceId "your-workspace-id" -username "your-username" -``` - -This example retrieves the workspace usage metrics for a specific workspace given the workspace ID and username. - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -username -The username. -This is a mandatory parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace. -This is a mandatory parameter. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -The function retrieves the PowerBI access token and creates a new usage metrics report. -It then defines the names of the reports to retrieve, initializes an empty hashtable to store the reports, and for each report name, retrieves the report and adds it to the hashtable. -It then returns the hashtable of reports. - -Author: Ioana Bouariu - -## RELATED LINKS diff --git a/documentation/Import-FabricEnvironmentStagingLibrary.md b/documentation/Import-FabricEnvironmentStagingLibrary.md deleted file mode 100644 index 81d9de7e..00000000 --- a/documentation/Import-FabricEnvironmentStagingLibrary.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Import-FabricEnvironmentStagingLibrary - -## SYNOPSIS -Uploads a library to the staging environment in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Import-FabricEnvironmentStagingLibrary [-WorkspaceId] [-EnvironmentId] - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to upload a library to the specified -environment staging area for the given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Import-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "env-67890" -``` - -## PARAMETERS - -### -EnvironmentId -The unique identifier of the environment where the library will be uploaded. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the environment exists. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- This is not working code. It is a placeholder for future development. Fabric documentation is missing some important details on how to upload libraries. -- 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 diff --git a/documentation/Import-FabricItem.md b/documentation/Import-FabricItem.md deleted file mode 100644 index c1c1ee7c..00000000 --- a/documentation/Import-FabricItem.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Import-FabricItem - -## SYNOPSIS -Imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. - -## SYNTAX - -``` -Import-FabricItem [[-path] ] [[-workspaceId] ] [[-filter] ] - [[-fileOverrides] ] [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Import-FabricItem function imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. -It supports multiple aliases for flexibility. -The function handles the import of datasets and reports, ensuring that the correct item type is used and that the items are created or updated as necessary. - -## EXAMPLES - -### EXAMPLE 1 -``` -Import-FabricItems -path 'C:\PBIPFiles' -workspaceId '12345' -filter 'C:\PBIPFiles\Reports' -``` - -This example imports PBIP files from the 'C:\PBIPFiles' folder into the Fabric workspace with ID '12345'. -It only searches for PBIP files in the 'C:\PBIPFiles\Reports' folder. - -## PARAMETERS - -### -fileOverrides -This parameter let's you override a PBIP file without altering the local file. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -filter -A filter to limit the search for PBIP files to specific folders. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -path -The path to the PBIP files. -Default value is '.\pbipOutput'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: .\pbipOutput -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -workspaceId -The ID of the Fabric workspace. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -This function requires the Invoke-FabricRestMethod function to be available in the current session. - -Author: Rui Romano - -## RELATED LINKS diff --git a/documentation/Invoke-FabricAPIRequest_duplicate.md b/documentation/Invoke-FabricAPIRequest_duplicate.md deleted file mode 100644 index 6879fb95..00000000 --- a/documentation/Invoke-FabricAPIRequest_duplicate.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Invoke-FabricAPIRequest_duplicate - -## SYNOPSIS -Sends an HTTP request to a Fabric API endpoint and retrieves the response. -Takes care of: authentication, 429 throttling, Long-Running-Operation (LRO) response - -## SYNTAX - -``` -Invoke-FabricAPIRequest_duplicate [-Headers] [-BaseURI] [-Method] - [[-Body] ] [[-ContentType] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -The Invoke-RestMethod function is used to send an HTTP request to a Fabric API endpoint and retrieve the response. -It handles various aspects such as authentication, 429 throttling, and Long-Running-Operation (LRO) response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Invoke-FabricAPIRequest_duplicate -uri "/api/resource" -method "Get" -``` - -This example sends a GET request to the "/api/resource" endpoint of the Fabric API. - -### EXAMPLE 2 -``` -Invoke-FabricAPIRequest_duplicate -authToken "abc123" -uri "/api/resource" -method "Post" -body $requestBody -``` - -This example sends a POST request to the "/api/resource" endpoint of the Fabric API with a request body. - -## PARAMETERS - -### -BaseURI -{{ Fill BaseURI Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -The body of the request, if applicable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentType -The content type of the request. -The default value is 'application/json; charset=utf-8'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: Application/json; charset=utf-8 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Headers -{{ Fill Headers Description }} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Method -The HTTP method to be used for the request. -Valid values are 'Get', 'Post', 'Delete', 'Put', and 'Patch'. -The default value is 'Get'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -This function requires the Get-FabricAuthToken function to be defined in the same script or module. - -Author: Rui Romano. - -## RELATED LINKS diff --git a/documentation/Invoke-FabricRestMethod.md b/documentation/Invoke-FabricRestMethod.md deleted file mode 100644 index 14e8e806..00000000 --- a/documentation/Invoke-FabricRestMethod.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Invoke-FabricRestMethod - -## SYNOPSIS -Sends an HTTP request to a Fabric API endpoint and retrieves the response. - -## SYNTAX - -``` -Invoke-FabricRestMethod [-Uri] [[-Method] ] [[-Body] ] [-TestTokenExpired] - [-PowerBIApi] [-ProgressAction ] [] -``` - -## DESCRIPTION -The Invoke-FabricRestMethod function is used to send an HTTP request to a Fabric API endpoint and retrieve the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Invoke-FabricRestMethod -uri "/api/resource" -method "GET" -``` - -This example sends a GET request to the "/api/resource" endpoint of the Fabric API. - -### EXAMPLE 2 -``` -Invoke-FabricRestMethod -uri "/api/resource" -method "POST" -body $requestBody -``` - -This example sends a POST request to the "/api/resource" endpoint of the Fabric API with a request body. - -## PARAMETERS - -### -Body -The body of the request, if applicable. -This can be a hashtable or a string. -If a hashtable is provided, it will be converted to JSON format. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Method -The HTTP method to be used for the request. -Valid values are 'GET', 'POST', 'DELETE', 'PUT', and 'PATCH'. -The default value is 'GET'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: GET -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PowerBIApi -A switch parameter to indicate that the request should be sent to the Power BI API instead of the Fabric API. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestTokenExpired -A switch parameter to test if the Fabric token is expired before making the request. -If the token is expired, it will attempt to refresh it. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -The URI of the Fabric API endpoint to send the request to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\`. - -Author: Kamil Nowinski - -## RELATED LINKS diff --git a/documentation/Invoke-FabricRestMethodExtended.md b/documentation/Invoke-FabricRestMethodExtended.md deleted file mode 100644 index 11642798..00000000 --- a/documentation/Invoke-FabricRestMethodExtended.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Invoke-FabricRestMethodExtended - -## SYNOPSIS -Sends an HTTP request to a Fabric API endpoint and retrieves the response. -Takes care of: authentication, 429 throttling, Long-Running-Operation (LRO) response - -## SYNTAX - -``` -Invoke-FabricRestMethodExtended [-Uri] [[-Method] ] [[-Body] ] [[-RetryCount] ] - [-ProgressAction ] [] -``` - -## DESCRIPTION -The Invoke-FabricRestMethodExtended function is used to send an HTTP request to a Fabric API endpoint and retrieve the response. -It handles various aspects such as authentication, 429 throttling, and Long-Running-Operation (LRO) response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Invoke-FabricRestMethodExtended -Uri "/api/resource" -Method "GET" -``` - -This example sends a GET request to the "/api/resource" endpoint of the Fabric API. - -### EXAMPLE 2 -``` -Invoke-FabricRestMethodExtended -Uri "/api/resource" -method "POST" -Body $requestBody -``` - -This example sends a POST request to the "/api/resource" endpoint of the Fabric API with a request body. - -## PARAMETERS - -### -Body -The body of the request, if applicable. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Method -The HTTP method to be used for the request. -Valid values are 'GET', 'POST', 'DELETE', 'PUT', and 'PATCH'. -The default value is 'GET'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: GET -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryCount -The number of times to retry the request in case of a 429 (Too Many Requests) error. -The default value is 0. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -The URI of the Fabric API endpoint to send the request to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -This function based on code that was originally written by Rui Romano (Invoke-FabricAPIRequest) and replaces it. -It's extended version of simple Invoke-FabricRestMethod function. -Requires \`$FabricConfig\` global configuration, including \`BaseUrl\`. - -Author: Kamil Nowinski - -## RELATED LINKS diff --git a/documentation/New-FabricCopyJob.md b/documentation/New-FabricCopyJob.md deleted file mode 100644 index 5effac75..00000000 --- a/documentation/New-FabricCopyJob.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricCopyJob - -## SYNOPSIS -Creates a new copy job in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricCopyJob [-WorkspaceId] [-CopyJobName] [[-CopyJobDescription] ] - [[-CopyJobPathDefinition] ] [[-CopyJobPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Sends a POST request to the Microsoft Fabric API to create a new copy job in the specified workspace. -Supports optional parameters for description and definition files. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobName "New Copy Job" -CopyJobDescription "Description of the new copy job" -``` - -## PARAMETERS - -### -CopyJobDescription -Optional description for the copy job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyJobName -The name of the copy job to be created. -Mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyJobPathDefinition -Optional file path to the copy job definition JSON file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyJobPathPlatformDefinition -Optional file path to the platform definition file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the copy job will be created. -Mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricDataPipeline.md b/documentation/New-FabricDataPipeline.md deleted file mode 100644 index c60a46f3..00000000 --- a/documentation/New-FabricDataPipeline.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricDataPipeline - -## SYNOPSIS -Creates a new DataPipeline in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricDataPipeline [-WorkspaceId] [-DataPipelineName] [[-DataPipelineDescription] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new DataPipeline -in the specified workspace. -It supports optional parameters for DataPipeline description -and path definitions for the DataPipeline content. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineName "New DataPipeline" -This example creates a new DataPipeline named "New DataPipeline" in the workspace with ID "workspace-12345" and uploads the definition file from the specified path. -``` - -## PARAMETERS - -### -DataPipelineDescription -An optional description for the DataPipeline. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataPipelineName -The name of the DataPipeline to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the DataPipeline will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricDomain.md b/documentation/New-FabricDomain.md deleted file mode 100644 index 072711cc..00000000 --- a/documentation/New-FabricDomain.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricDomain - -## SYNOPSIS -Creates a new Fabric domain. - -## SYNTAX - -``` -New-FabricDomain [-DomainName] [[-DomainDescription] ] [[-ParentDomainId] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Add-FabricDomain\` function creates a new domain in Microsoft Fabric by making a POST request to the relevant API endpoint. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricDomain -DomainName "Finance" -DomainDescription "Finance data domain" -ParentDomainId "12345" -``` - -Creates a "Finance" domain under the parent domain with ID "12345". - -## PARAMETERS - -### -DomainDescription -A description of the domain to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -The name of the domain to be created. -Must only contain alphanumeric characters, underscores, and spaces. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentDomainId -(Optional) The ID of the parent domain, if applicable. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricEnvironment.md b/documentation/New-FabricEnvironment.md deleted file mode 100644 index ad49a9f0..00000000 --- a/documentation/New-FabricEnvironment.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricEnvironment - -## SYNOPSIS -Creates a new environment in a specified workspace. - -## SYNTAX - -``` -New-FabricEnvironment [-WorkspaceId] [-EnvironmentName] [[-EnvironmentDescription] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Add-FabricEnvironment\` function creates a new environment within a given workspace by making a POST request to the Fabric API. -The environment can optionally include a description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricEnvironment -WorkspaceId "12345" -EnvironmentName "DevEnv" -EnvironmentDescription "Development Environment" -``` - -Creates an environment named "DevEnv" in workspace "12345" with the specified description. - -## PARAMETERS - -### -EnvironmentDescription -(Optional) A description of the environment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -(Mandatory) The name of the environment to be created. -Only alphanumeric characters, spaces, and underscores are allowed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace where the environment will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricEventhouse.md b/documentation/New-FabricEventhouse.md deleted file mode 100644 index cecbce3b..00000000 --- a/documentation/New-FabricEventhouse.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricEventhouse - -## SYNOPSIS -Creates a new Eventhouse in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricEventhouse [-WorkspaceId] [-EventhouseName] [[-EventhouseDescription] ] - [[-EventhousePathDefinition] ] [[-EventhousePathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new Eventhouse -in the specified workspace. -It supports optional parameters for Eventhouse description and path definitions. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseName "New Eventhouse" -EventhouseDescription "Description of the new Eventhouse" -This example creates a new Eventhouse named "New Eventhouse" in the workspace with ID "workspace-12345" with the provided description. -``` - -## PARAMETERS - -### -EventhouseDescription -An optional description for the Eventhouse. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventhouseName -The name of the Eventhouse to be created. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventhousePathDefinition -An optional path to the Eventhouse definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventhousePathPlatformDefinition -An optional path to the platform-specific definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Eventhouse will be created. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricEventstream.md b/documentation/New-FabricEventstream.md deleted file mode 100644 index 3ef8f3f2..00000000 --- a/documentation/New-FabricEventstream.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricEventstream - -## SYNOPSIS -Creates a new Eventstream in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricEventstream [-WorkspaceId] [-EventstreamName] [[-EventstreamDescription] ] - [[-EventstreamPathDefinition] ] [[-EventstreamPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new Eventstream -in the specified workspace. -It supports optional parameters for Eventstream description -and path definitions for the Eventstream content. - -## EXAMPLES - -### EXAMPLE 1 -``` -#TODO Fix example name -Add-FabricEventstream -WorkspaceId "workspace-12345" -EventstreamName "New Eventstream" -EventstreamPathDefinition "C:\Eventstreams\example.ipynb" -``` - -## PARAMETERS - -### -EventstreamDescription -An optional description for the Eventstream. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventstreamName -The name of the Eventstream to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventstreamPathDefinition -An optional path to the Eventstream definition file (e.g., .ipynb file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventstreamPathPlatformDefinition -An optional path to the platform-specific definition (e.g., .platform file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Eventstream will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 - - -TODO SupportsShouldProcess - -## RELATED LINKS diff --git a/documentation/New-FabricKQLDashboard.md b/documentation/New-FabricKQLDashboard.md deleted file mode 100644 index ed12f51f..00000000 --- a/documentation/New-FabricKQLDashboard.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricKQLDashboard - -## SYNOPSIS -Creates a new KQLDashboard in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricKQLDashboard [-WorkspaceId] [-KQLDashboardName] [[-KQLDashboardDescription] ] - [[-KQLDashboardPathDefinition] ] [[-KQLDashboardPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new KQLDashboard -in the specified workspace. -It supports optional parameters for KQLDashboard description -and path definitions for the KQLDashboard content. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricKQLDashboard -WorkspaceId "workspace-12345" -KQLDashboardName "New KQLDashboard" -KQLDashboardPathDefinition "C:\KQLDashboards\example.ipynb" -``` - -## PARAMETERS - -### -KQLDashboardDescription -An optional description for the KQLDashboard. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDashboardName -The name of the KQLDashboard to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDashboardPathDefinition -An optional path to the KQLDashboard definition file (e.g., .ipynb file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDashboardPathPlatformDefinition -An optional path to the platform-specific definition (e.g., .platform file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the KQLDashboard will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricKQLDatabase.md b/documentation/New-FabricKQLDatabase.md deleted file mode 100644 index 89193022..00000000 --- a/documentation/New-FabricKQLDatabase.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricKQLDatabase - -## SYNOPSIS -Creates a new KQLDatabase in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricKQLDatabase [-WorkspaceId] [-KQLDatabaseName] [[-KQLDatabaseDescription] ] - [[-parentEventhouseId] ] [-KQLDatabaseType] [[-KQLInvitationToken] ] - [[-KQLSourceClusterUri] ] [[-KQLSourceDatabaseName] ] [[-KQLDatabasePathDefinition] ] - [[-KQLDatabasePathPlatformDefinition] ] [[-KQLDatabasePathSchemaDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new KQLDatabase -in the specified workspace. -It supports optional parameters for KQLDatabase description -and path definitions for the KQLDatabase content. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricKQLDatabase -WorkspaceId "workspace-12345" -KQLDatabaseName "New KQLDatabase" -KQLDatabasePathDefinition "C:\KQLDatabases\example.ipynb" -``` - -## PARAMETERS - -### -KQLDatabaseDescription -An optional description for the KQLDatabase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabaseName -The name of the KQLDatabase to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabasePathDefinition -An optional path to the KQLDatabase definition file (e.g., .ipynb file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabasePathPlatformDefinition -An optional path to the platform-specific definition (e.g., .platform file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabasePathSchemaDefinition -the path to the KQLDatabase schema definition file (e.g., .kql file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabaseType -The type of KQLDatabase to create. -Valid values are "ReadWrite" and "Shortcut". - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLInvitationToken -An optional invitation token for the KQLDatabase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLSourceClusterUri -An optional source cluster URI for the KQLDatabase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLSourceDatabaseName -An optional source database name for the KQLDatabase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -parentEventhouseId -The ID of the parent Eventhouse item for the KQLDatabase. -This is mandatory for ReadWrite type databases. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the KQLDatabase will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- Precedent Request Body - - Definition file high priority. - - CreationPayload is evaluate only if Definition file is not provided. - - invitationToken has priority over all other payload fields. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/New-FabricKQLQueryset.md b/documentation/New-FabricKQLQueryset.md deleted file mode 100644 index 998cb705..00000000 --- a/documentation/New-FabricKQLQueryset.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricKQLQueryset - -## SYNOPSIS -Creates a new KQLQueryset in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricKQLQueryset [-WorkspaceId] [-KQLQuerysetName] [[-KQLQuerysetDescription] ] - [[-KQLQuerysetPathDefinition] ] [[-KQLQuerysetPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new KQLQueryset -in the specified workspace. -It supports optional parameters for KQLQueryset description -and path definitions for the KQLQueryset content. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricKQLQueryset -WorkspaceId "workspace-12345" -KQLQuerysetName "New KQLQueryset" -KQLQuerysetPathDefinition "C:\KQLQuerysets\example.ipynb" -``` - -## PARAMETERS - -### -KQLQuerysetDescription -An optional description for the KQLQueryset. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLQuerysetName -The name of the KQLQueryset to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLQuerysetPathDefinition -An optional path to the KQLQueryset definition file (e.g., .ipynb file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLQuerysetPathPlatformDefinition -An optional path to the platform-specific definition (e.g., .platform file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the KQLQueryset will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricLakehouse.md b/documentation/New-FabricLakehouse.md deleted file mode 100644 index 270c92ce..00000000 --- a/documentation/New-FabricLakehouse.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricLakehouse - -## SYNOPSIS -Creates a new Lakehouse in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricLakehouse [-WorkspaceId] [-LakehouseName] [[-LakehouseDescription] ] - [[-LakehouseEnableSchemas] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new Lakehouse -in the specified workspace. -It supports optional parameters for Lakehouse description -and path definitions for the Lakehouse content. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricLakehouse -WorkspaceId "workspace-12345" -LakehouseName "New Lakehouse" -LakehouseEnableSchemas $true -``` - -## PARAMETERS - -### -LakehouseDescription -An optional description for the Lakehouse. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LakehouseEnableSchemas -An optional path to enable schemas in the Lakehouse - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LakehouseName -The name of the Lakehouse to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Lakehouse will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricMLExperiment.md b/documentation/New-FabricMLExperiment.md deleted file mode 100644 index 2c23bb7c..00000000 --- a/documentation/New-FabricMLExperiment.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricMLExperiment - -## SYNOPSIS -Creates a new ML Experiment in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricMLExperiment [-WorkspaceId] [-MLExperimentName] [[-MLExperimentDescription] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new ML Experiment -in the specified workspace. -It supports optional parameters for ML Experiment description. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentName "New ML Experiment" -MLExperimentDescription "Description of the new ML Experiment" -This example creates a new ML Experiment named "New ML Experiment" in the workspace with ID "workspace-12345" with the provided description. -``` - -## PARAMETERS - -### -MLExperimentDescription -An optional description for the ML Experiment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MLExperimentName -The name of the ML Experiment to be created. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the ML Experiment will be created. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricMLModel.md b/documentation/New-FabricMLModel.md deleted file mode 100644 index e5d4f653..00000000 --- a/documentation/New-FabricMLModel.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricMLModel - -## SYNOPSIS -Creates a new ML Model in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricMLModel [-WorkspaceId] [-MLModelName] [[-MLModelDescription] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new ML Model -in the specified workspace. -It supports optional parameters for ML Model description. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricMLModel -WorkspaceId "workspace-12345" -MLModelName "New ML Model" -MLModelDescription "Description of the new ML Model" -This example creates a new ML Model named "New ML Model" in the workspace with ID "workspace-12345" with the provided description. -``` - -## PARAMETERS - -### -MLModelDescription -An optional description for the ML Model. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MLModelName -The name of the ML Model to be created. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the ML Model will be created. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricMirroredDatabase.md b/documentation/New-FabricMirroredDatabase.md deleted file mode 100644 index 381857d4..00000000 --- a/documentation/New-FabricMirroredDatabase.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricMirroredDatabase - -## SYNOPSIS -Creates a new MirroredDatabase in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricMirroredDatabase [-WorkspaceId] [-MirroredDatabaseName] - [[-MirroredDatabaseDescription] ] [[-MirroredDatabasePathDefinition] ] - [[-MirroredDatabasePathPlatformDefinition] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new MirroredDatabase -in the specified workspace. -It supports optional parameters for MirroredDatabase description -and path definitions for the MirroredDatabase content. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricMirroredDatabase -WorkspaceId "workspace-12345" -MirroredDatabaseName "New MirroredDatabase" -MirroredDatabasePathDefinition "C:\MirroredDatabases\example.json" -``` - -## PARAMETERS - -### -MirroredDatabaseDescription -An optional description for the MirroredDatabase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MirroredDatabaseName -The name of the MirroredDatabase to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MirroredDatabasePathDefinition -An optional path to the MirroredDatabase definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MirroredDatabasePathPlatformDefinition -An optional path to the platform-specific definition (e.g., .platform file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the MirroredDatabase will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricNotebook.md b/documentation/New-FabricNotebook.md deleted file mode 100644 index b76a3431..00000000 --- a/documentation/New-FabricNotebook.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricNotebook - -## SYNOPSIS -Creates a new notebook in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricNotebook [-WorkspaceId] [-NotebookName] [[-NotebookDescription] ] - [[-NotebookPathDefinition] ] [[-NotebookPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new notebook -in the specified workspace. -It supports optional parameters for notebook description -and path definitions for the notebook content. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricNotebook -WorkspaceId "workspace-12345" -NotebookName "New Notebook" -NotebookPathDefinition "C:\notebooks\example.ipynb" -``` - -## PARAMETERS - -### -NotebookDescription -An optional description for the notebook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookName -The name of the notebook to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookPathDefinition -An optional path to the notebook definition file (e.g., .ipynb file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookPathPlatformDefinition -An optional path to the platform-specific definition (e.g., .platform file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the notebook will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricNotebookNEW.md b/documentation/New-FabricNotebookNEW.md deleted file mode 100644 index bd29875c..00000000 --- a/documentation/New-FabricNotebookNEW.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricNotebookNEW - -## SYNOPSIS -Creates a new notebook in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricNotebookNEW [-WorkspaceId] [-NotebookName] [[-NotebookDescription] ] - [[-NotebookPathDefinition] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new notebook -in the specified workspace. -It supports optional parameters for notebook description -and path definitions for the notebook content. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricNotebook -WorkspaceId "workspace-12345" -NotebookName "New Notebook" -NotebookPathDefinition "C:\notebooks\example.ipynb" -``` - -## PARAMETERS - -### -NotebookDescription -An optional description for the notebook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookName -The name of the notebook to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookPathDefinition -An optional path to the notebook definition file (e.g., .ipynb file) to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the notebook will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricRecoveryPoint.md b/documentation/New-FabricRecoveryPoint.md deleted file mode 100644 index 1fc18ea9..00000000 --- a/documentation/New-FabricRecoveryPoint.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricRecoveryPoint - -## SYNOPSIS -Create a recovery point for a Fabric data warehouse - -## SYNTAX - -``` -New-FabricRecoveryPoint [[-WorkspaceGUID] ] [[-DataWarehouseGUID] ] [[-BaseUrl] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Create a recovery point for a Fabric data warehouse - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricRecoveryPoint -``` - -Create a new recovery point for the data warehouse specified in the configuration. - -### EXAMPLE 2 -``` -New-FabricRecoveryPoint -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -``` - -Create a new recovery point for the specified data warehouse, in the specified workspace. - -## PARAMETERS - -### -BaseUrl -Defaults to api.powerbi.com - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: Api.powerbi.com -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataWarehouseGUID -The GUID for the data warehouse which we want to retrieve restore points for. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceGUID -This is the workspace GUID in which the data warehouse resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Jess Pomfret - -## RELATED LINKS diff --git a/documentation/New-FabricReflex.md b/documentation/New-FabricReflex.md deleted file mode 100644 index 32f73d39..00000000 --- a/documentation/New-FabricReflex.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricReflex - -## SYNOPSIS -Creates a new Reflex in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricReflex [-WorkspaceId] [-ReflexName] [[-ReflexDescription] ] - [[-ReflexPathDefinition] ] [[-ReflexPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new Reflex -in the specified workspace. -It supports optional parameters for Reflex description and path definitions. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricReflex -WorkspaceId "workspace-12345" -ReflexName "New Reflex" -ReflexDescription "Description of the new Reflex" -This example creates a new Reflex named "New Reflex" in the workspace with ID "workspace-12345" with the provided description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexDescription -An optional description for the Reflex. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexName -The name of the Reflex to be created. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexPathDefinition -An optional path to the Reflex definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexPathPlatformDefinition -An optional path to the platform-specific definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Reflex will be created. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricReport.md b/documentation/New-FabricReport.md deleted file mode 100644 index 49bad7e2..00000000 --- a/documentation/New-FabricReport.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricReport - -## SYNOPSIS -Creates a new Report in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricReport [-WorkspaceId] [-ReportName] [[-ReportDescription] ] - [-ReportPathDefinition] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new Report -in the specified workspace. -It supports optional parameters for Report description and path definitions. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricReport -WorkspaceId "workspace-12345" -ReportName "New Report" -ReportDescription "Description of the new Report" -This example creates a new Report named "New Report" in the workspace with ID "workspace-12345" with the provided description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportDescription -An optional description for the Report. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportName -The name of the Report to be created. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportPathDefinition -A mandatory path to the folder that contains Report definition files to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Report will be created. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricSQLDatabase.md b/documentation/New-FabricSQLDatabase.md deleted file mode 100644 index 99374c33..00000000 --- a/documentation/New-FabricSQLDatabase.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricSQLDatabase - -## SYNOPSIS -Creates a new SQL Database in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricSQLDatabase [-WorkspaceId] [-Name] [[-Description] ] [-NoWait] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new SQL Database -in the specified workspace. -It supports optional parameters for SQL Database description -and path definitions for the SQL Database content. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricSQLDatabase -WorkspaceId "workspace-12345" -Name "NewDatabase" -``` - -## PARAMETERS - -### -Description -An optional description for the SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the SQL Database to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -If specified, the function will not wait for the operation to complete and will return immediately. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SQL Database will be created. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. - -Author: Kamil Nowinski - -## RELATED LINKS diff --git a/documentation/New-FabricSemanticModel.md b/documentation/New-FabricSemanticModel.md deleted file mode 100644 index ad52c523..00000000 --- a/documentation/New-FabricSemanticModel.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricSemanticModel - -## SYNOPSIS -Creates a new SemanticModel in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricSemanticModel [-WorkspaceId] [-SemanticModelName] - [[-SemanticModelDescription] ] [-SemanticModelPathDefinition] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new SemanticModel -in the specified workspace. -It supports optional parameters for SemanticModel description and path definitions. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelName "New SemanticModel" -SemanticModelDescription "Description of the new SemanticModel" -This example creates a new SemanticModel named "New SemanticModel" in the workspace with ID "workspace-12345" with the provided description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelDescription -An optional description for the SemanticModel. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelName -The name of the SemanticModel to be created. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelPathDefinition -An optional path to the SemanticModel definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SemanticModel will be created. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricSparkCustomPool.md b/documentation/New-FabricSparkCustomPool.md deleted file mode 100644 index 98c3ee28..00000000 --- a/documentation/New-FabricSparkCustomPool.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricSparkCustomPool - -## SYNOPSIS -Creates a new Spark custom pool in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricSparkCustomPool [-WorkspaceId] [-SparkCustomPoolName] [-NodeFamily] - [-NodeSize] [-AutoScaleEnabled] [-AutoScaleMinNodeCount] - [-AutoScaleMaxNodeCount] [-DynamicExecutorAllocationEnabled] - [-DynamicExecutorAllocationMinExecutors] [-DynamicExecutorAllocationMaxExecutors] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new Spark custom pool -in the specified workspace. -It supports various parameters for Spark custom pool configuration. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolName "New Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 -This example creates a new Spark custom pool named "New Spark Pool" in the workspace with ID "workspace-12345" with the specified configuration. -``` - -## PARAMETERS - -### -AutoScaleEnabled -Specifies whether auto-scaling is enabled for the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoScaleMaxNodeCount -The maximum number of nodes for auto-scaling in the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 7 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoScaleMinNodeCount -The minimum number of nodes for auto-scaling in the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicExecutorAllocationEnabled -Specifies whether dynamic executor allocation is enabled for the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 8 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicExecutorAllocationMaxExecutors -The maximum number of executors for dynamic executor allocation in the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 10 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicExecutorAllocationMinExecutors -The minimum number of executors for dynamic executor allocation in the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 9 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeFamily -The family of nodes to be used in the Spark custom pool. -This parameter is mandatory and must be 'MemoryOptimized'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeSize -The size of the nodes to be used in the Spark custom pool. -This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkCustomPoolName -The name of the Spark custom pool to be created. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Spark custom pool will be created. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricSparkJobDefinition.md b/documentation/New-FabricSparkJobDefinition.md deleted file mode 100644 index bf66debf..00000000 --- a/documentation/New-FabricSparkJobDefinition.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricSparkJobDefinition - -## SYNOPSIS -Creates a new SparkJobDefinition in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricSparkJobDefinition [-WorkspaceId] [-SparkJobDefinitionName] - [[-SparkJobDefinitionDescription] ] [[-SparkJobDefinitionPathDefinition] ] - [[-SparkJobDefinitionPathPlatformDefinition] ] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new SparkJobDefinition -in the specified workspace. -It supports optional parameters for SparkJobDefinition description and path definitions. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionName "New SparkJobDefinition" -SparkJobDefinitionDescription "Description of the new SparkJobDefinition" -This example creates a new SparkJobDefinition named "New SparkJobDefinition" in the workspace with ID "workspace-12345" with the provided description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionDescription -An optional description for the SparkJobDefinition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionName -The name of the SparkJobDefinition to be created. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionPathDefinition -An optional path to the SparkJobDefinition definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionPathPlatformDefinition -An optional path to the platform-specific definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SparkJobDefinition will be created. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricWarehouse.md b/documentation/New-FabricWarehouse.md deleted file mode 100644 index 0f746bce..00000000 --- a/documentation/New-FabricWarehouse.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricWarehouse - -## SYNOPSIS -Creates a new warehouse in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -New-FabricWarehouse [-WorkspaceId] [-WarehouseName] [[-WarehouseDescription] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to create a new warehouse -in the specified workspace. -It supports optional parameters for warehouse description. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseName "New Warehouse" -WarehouseDescription "Description of the new warehouse" -This example creates a new warehouse named "New Warehouse" in the workspace with ID "workspace-12345" with the provided description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarehouseDescription -An optional description for the warehouse. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarehouseName -The name of the warehouse to be created. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the warehouse will be created. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricWorkspace.md b/documentation/New-FabricWorkspace.md deleted file mode 100644 index 6e39665f..00000000 --- a/documentation/New-FabricWorkspace.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricWorkspace - -## SYNOPSIS -Creates a new Fabric workspace with the specified display name. - -## SYNTAX - -``` -New-FabricWorkspace [-WorkspaceName] [[-WorkspaceDescription] ] [[-CapacityId] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Add-FabricWorkspace\` function creates a new workspace in the Fabric platform by sending a POST request to the API. -It validates the display name and handles both success and error responses. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-FabricWorkspace -WorkspaceName "NewWorkspace" -``` - -Creates a workspace named "NewWorkspace". - -## PARAMETERS - -### -CapacityId -(Optional) The ID of the capacity to be associated with the workspace. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceDescription -(Optional) A description for the workspace. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceName -The display name of the workspace to be created. -Must only contain alphanumeric characters, spaces, and underscores. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/New-FabricWorkspaceUsageMetricsReport.md b/documentation/New-FabricWorkspaceUsageMetricsReport.md deleted file mode 100644 index 514540e7..00000000 --- a/documentation/New-FabricWorkspaceUsageMetricsReport.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# New-FabricWorkspaceUsageMetricsReport - -## SYNOPSIS -Retrieves the workspace usage metrics dataset ID. - -## SYNTAX - -``` -New-FabricWorkspaceUsageMetricsReport [-WorkspaceId] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The New-FabricWorkspaceUsageMetricsReport function retrieves the workspace usage metrics dataset ID. -It supports multiple aliases for flexibility. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-FabricWorkspaceUsageMetricsReport -workspaceId "your-workspace-id" -``` - -This example retrieves the workspace usage metrics dataset ID for a specific workspace given the workspace ID. - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace. -This is a mandatory parameter. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -The function retrieves the PowerBI access token and the Fabric API cluster URI. -It then makes a GET request to the Fabric API to retrieve the workspace usage metrics dataset ID, parses the response and replaces certain keys to match the expected format, and returns the 'dbName' property of the first model in the response, which is the dataset ID. - -Author: Ioana Bouariu - -## RELATED LINKS diff --git a/documentation/Publish-FabricEnvironment.md b/documentation/Publish-FabricEnvironment.md deleted file mode 100644 index d12e6f64..00000000 --- a/documentation/Publish-FabricEnvironment.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Publish-FabricEnvironment - -## SYNOPSIS -Publishes a staging environment in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Publish-FabricEnvironment [-WorkspaceId] [-EnvironmentId] [-ProgressAction ] - [] -``` - -## DESCRIPTION -This function interacts with the Microsoft Fabric API to initiate the publishing process for a staging environment. -It validates the authentication token, constructs the API request, and handles both immediate and long-running operations. - -## EXAMPLES - -### EXAMPLE 1 -``` -Publish-FabricEnvironment -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -``` - -Initiates the publishing process for the specified staging environment. - -## PARAMETERS - -### -EnvironmentId -The unique identifier of the staging environment to be published. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace containing the staging environment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires the \`$FabricConfig\` global object, including \`BaseUrl\` and \`FabricHeaders\`. -- Uses \`Confirm-TokenState\` to validate the token before making API calls. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Register-FabricWorkspaceToCapacity.md b/documentation/Register-FabricWorkspaceToCapacity.md deleted file mode 100644 index 4437103f..00000000 --- a/documentation/Register-FabricWorkspaceToCapacity.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Register-FabricWorkspaceToCapacity - -## SYNOPSIS -Sets a PowerBI workspace to a capacity. - -## SYNTAX - -### WorkspaceId -``` -Register-FabricWorkspaceToCapacity [-WorkspaceId ] -CapacityId - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -### WorkspaceObject -``` -Register-FabricWorkspaceToCapacity [-Workspace ] -CapacityId - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Register-FabricWorkspaceToCapacity function Sets a PowerBI workspace to a capacity. -It supports multiple aliases for flexibility. - -## EXAMPLES - -### EXAMPLE 1 -``` -Register-FabricWorkspaceToCapacity -WorkspaceId "Workspace-GUID" -CapacityId "Capacity-GUID" -``` - -This example Sets the workspace with ID "Workspace-GUID" to the capacity with ID "Capacity-GUID". - -### EXAMPLE 2 -``` -$workspace | Register-FabricWorkspaceToCapacity -CapacityId "Capacity-GUID" -``` - -This example Sets the workspace object stored in the $workspace variable to the capacity with ID "Capacity-GUID". -The workspace object is piped into the function. - -## PARAMETERS - -### -CapacityId -The ID of the capacity to which the workspace will be Seted. -This is a mandatory parameter. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Workspace -The workspace object to be Seted. -This is a mandatory parameter and can be piped into the function. - -```yaml -Type: System.Object -Parameter Sets: WorkspaceObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace to be Seted. -This is a mandatory parameter. - -```yaml -Type: System.Guid -Parameter Sets: WorkspaceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -The function makes a POST request to the PowerBI API to Set the workspace to the capacity. -The PowerBI access token is retrieved using the Get-PowerBIAccessToken function. - -Author: Ioana Bouariu - -## RELATED LINKS diff --git a/documentation/Remove-FabricCopyJob.md b/documentation/Remove-FabricCopyJob.md deleted file mode 100644 index fd2764b0..00000000 --- a/documentation/Remove-FabricCopyJob.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Remove-FabricCopyJob - -## SYNOPSIS -Deletes a Copy Job from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricCopyJob [-WorkspaceId] [-CopyJobId] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This function performs a DELETE operation on the Microsoft Fabric API to remove a Copy Job -from the specified workspace using the provided WorkspaceId and CopyJobId parameters. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "copyjob-67890" -Deletes the Copy Job with ID "copyjob-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -CopyJobId -The unique identifier of the Copy Job to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace containing the Copy Job to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires the \`$FabricConfig\` global configuration, which must include \`BaseUrl\` and \`FabricHeaders\`. -- Ensures token validity by invoking \`Confirm-TokenState\` before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricDataPipeline.md b/documentation/Remove-FabricDataPipeline.md deleted file mode 100644 index eee69d95..00000000 --- a/documentation/Remove-FabricDataPipeline.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Remove-FabricDataPipeline - -## SYNOPSIS -Removes a DataPipeline from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricDataPipeline [-WorkspaceId] [-DataPipelineId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove a DataPipeline -from the specified workspace using the provided WorkspaceId and DataPipelineId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineId "pipeline-67890" -This example removes the DataPipeline with ID "pipeline-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -DataPipelineId -The unique identifier of the DataPipeline to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the DataPipeline will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricDomain.md b/documentation/Remove-FabricDomain.md deleted file mode 100644 index 8e1759cf..00000000 --- a/documentation/Remove-FabricDomain.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Remove-FabricDomain - -## SYNOPSIS -Deletes a Fabric domain by its ID. - -## SYNTAX - -``` -Remove-FabricDomain [-DomainId] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Remove-FabricDomain\` function removes a specified domain from Microsoft Fabric by making a DELETE request to the relevant API endpoint. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricDomain -DomainId "12345" -``` - -Deletes the domain with ID "12345". - -## PARAMETERS - -### -DomainId -The unique identifier of the domain to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricDomainWorkspaceAssignment.md b/documentation/Remove-FabricDomainWorkspaceAssignment.md deleted file mode 100644 index 249fad59..00000000 --- a/documentation/Remove-FabricDomainWorkspaceAssignment.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Remove-FabricDomainWorkspaceAssignment - -## SYNOPSIS -Unassign workspaces from a specified Fabric domain. - -## SYNTAX - -``` -Remove-FabricDomainWorkspaceAssignment [-DomainId] [[-WorkspaceIds] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Unassign -FabricDomainWorkspace\` function allows you to Unassign specific workspaces from a given Fabric domain or unassign all workspaces if no workspace IDs are specified. -It makes a POST request to the relevant API endpoint for this operation. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricDomainWorkspaceAssignment -DomainId "12345" -``` - -Unassigns all workspaces from the domain with ID "12345". - -### EXAMPLE 2 -``` -Remove-FabricDomainWorkspaceAssignment -DomainId "12345" -WorkspaceIds @("workspace1", "workspace2") -``` - -Unassigns the specified workspaces from the domain with ID "12345". - -## PARAMETERS - -### -DomainId -The unique identifier of the Fabric domain. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceIds -(Optional) An array of workspace IDs to unassign. -If not provided, all workspaces will be unassigned. - -```yaml -Type: System.Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricDomainWorkspaceRoleAssignment.md b/documentation/Remove-FabricDomainWorkspaceRoleAssignment.md deleted file mode 100644 index 0e27bbd7..00000000 --- a/documentation/Remove-FabricDomainWorkspaceRoleAssignment.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Remove-FabricDomainWorkspaceRoleAssignment - -## SYNOPSIS -Bulk unUnassign roles to principals for workspaces in a Fabric domain. - -## SYNTAX - -``` -Remove-FabricDomainWorkspaceRoleAssignment [-DomainId] [-DomainRole] [-PrincipalIds] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`AssignFabricDomainWorkspaceRoleAssignment\` function performs bulk role assignments for principals in a specific Fabric domain. -It sends a POST request to the relevant API endpoint. - -## EXAMPLES - -### EXAMPLE 1 -``` -AssignFabricDomainWorkspaceRoleAssignment -DomainId "12345" -DomainRole "Admins" -PrincipalIds @(@{id="user1"; type="User"}, @{id="group1"; type="Group"}) -``` - -Unassign the \`Admins\` role to the specified principals in the domain with ID "12345". - -## PARAMETERS - -### -DomainId -The unique identifier of the Fabric domain where roles will be assigned. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainRole -The role to assign to the principals. -Must be one of the following: -- \`Admins\` -- \`Contributors\` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalIds -An array of principals to assign roles to. -Each principal must include: -- \`id\`: The identifier of the principal. -- \`type\`: The type of the principal (e.g., \`User\`, \`Group\`). - -```yaml -Type: System.Array -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricEnvironment.md b/documentation/Remove-FabricEnvironment.md deleted file mode 100644 index cc2a635d..00000000 --- a/documentation/Remove-FabricEnvironment.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Remove-FabricEnvironment - -## SYNOPSIS -Deletes an environment from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Remove-FabricEnvironment [-WorkspaceId] [-EnvironmentId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricEnvironment\` function sends a DELETE request to the Fabric API to remove a specified environment from a given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricEnvironment -WorkspaceId "12345" -EnvironmentId "67890" -``` - -Deletes the environment with ID "67890" from workspace "12345". - -## PARAMETERS - -### -EnvironmentId -(Mandatory) The ID of the environment to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace containing the environment to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricEnvironmentStagingLibrary.md b/documentation/Remove-FabricEnvironmentStagingLibrary.md deleted file mode 100644 index 9ce5d63f..00000000 --- a/documentation/Remove-FabricEnvironmentStagingLibrary.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP -schema: 2.0.0 ---- - -# Remove-FabricEnvironmentStagingLibrary - -## SYNOPSIS -Deletes a specified library from the staging environment in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricEnvironmentStagingLibrary [-WorkspaceId] [-EnvironmentId] [-LibraryName] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function allows for the deletion of a library from the staging environment, one file at a time. -It ensures token validity, constructs the appropriate API request, and handles both success and failure responses. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -LibraryName "library-to-delete" -``` - -Deletes the specified library from the staging environment in the specified workspace. - -## PARAMETERS - -### -EnvironmentId -The unique identifier of the staging environment containing the library. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LibraryName -The name of the library to be deleted from the environment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the library is to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. -- This function currently supports deleting one library at a time. -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricEventhouse.md b/documentation/Remove-FabricEventhouse.md deleted file mode 100644 index 139ea39c..00000000 --- a/documentation/Remove-FabricEventhouse.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricEventhouse - -## SYNOPSIS -Removes an Eventhouse from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricEventhouse [-WorkspaceId] [-EventhouseId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove an Eventhouse -from the specified workspace using the provided WorkspaceId and EventhouseId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -This example removes the Eventhouse with ID "eventhouse-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -EventhouseId -The unique identifier of the Eventhouse to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the Eventhouse will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Revsion History: - -- 2024-11-07 - FGE: Implemented SupportShouldProcess -- 2024-11-09 - FGE: Added DisplaName as Alias for EventhouseName -- 2024-11-27 - FGE: Added Verbose Output - -## RELATED LINKS - -[https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch](https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch) - -[https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch]() - diff --git a/documentation/Remove-FabricEventstream.md b/documentation/Remove-FabricEventstream.md deleted file mode 100644 index fd7b247a..00000000 --- a/documentation/Remove-FabricEventstream.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricEventstream - -## SYNOPSIS -Deletes an Eventstream from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Remove-FabricEventstream [-WorkspaceId] [-EventstreamId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricEventstream\` function sends a DELETE request to the Fabric API to remove a specified Eventstream from a given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricEventstream -WorkspaceId "12345" -EventstreamId "67890" -``` - -Deletes the Eventstream with ID "67890" from workspace "12345". - -## PARAMETERS - -### -EventstreamId -(Mandatory) The ID of the Eventstream to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace containing the Eventstream to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricItem.md b/documentation/Remove-FabricItem.md deleted file mode 100644 index 28877271..00000000 --- a/documentation/Remove-FabricItem.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricItem - -## SYNOPSIS -Removes selected items from a Fabric workspace. - -## SYNTAX - -``` -Remove-FabricItem [-WorkspaceId] [[-filter] ] [[-itemID] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Remove-FabricItems function removes selected items from a specified Fabric workspace. -It uses the workspace ID and an optional filter to select the items to remove. -If a filter is provided, only items whose DisplayName matches the filter are removed. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricItems -WorkspaceID "12345678-90ab-cdef-1234-567890abcdef" -Filter "*test*" -``` - -This command removes all items from the workspace with the specified ID whose DisplayName includes "test". - -## PARAMETERS - -### -filter -An optional filter to select items to remove. -If provided, only items whose DisplayName matches the filter are removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -itemID -The ID of a specific item to remove. -If provided, this item is removed regardless of the filter - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the Fabric workspace. -This is a mandatory parameter. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String. You can pipe two strings that contain the workspace ID and filter to Remove-FabricItems. -## OUTPUTS - -### None. This function does not return any output. -## NOTES -Author: Rui Romano -https://github.com/microsoft/Analysis-Services/tree/master/pbidevmode/fabricps-pbip - -## RELATED LINKS diff --git a/documentation/Remove-FabricKQLDashboard.md b/documentation/Remove-FabricKQLDashboard.md deleted file mode 100644 index 7234c490..00000000 --- a/documentation/Remove-FabricKQLDashboard.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricKQLDashboard - -## SYNOPSIS -Deletes an KQLDashboard from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Remove-FabricKQLDashboard [-WorkspaceId] [-KQLDashboardId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricKQLDashboard\` function sends a DELETE request to the Fabric API to remove a specified KQLDashboard from a given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricKQLDashboard -WorkspaceId "12345" -KQLDashboardId "67890" -``` - -Deletes the KQLDashboard with ID "67890" from workspace "12345". - -## PARAMETERS - -### -KQLDashboardId -(Mandatory) The ID of the KQLDashboard to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace containing the KQLDashboard to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricKQLDatabase.md b/documentation/Remove-FabricKQLDatabase.md deleted file mode 100644 index 5e19336e..00000000 --- a/documentation/Remove-FabricKQLDatabase.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricKQLDatabase - -## SYNOPSIS -Deletes an KQLDatabase from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Remove-FabricKQLDatabase [-WorkspaceId] [-KQLDatabaseId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricKQLDatabase\` function sends a DELETE request to the Fabric API to remove a specified KQLDatabase from a given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricKQLDatabase -WorkspaceId "12345" -KQLDatabaseId "67890" -``` - -Deletes the KQLDatabase with ID "67890" from workspace "12345". - -## PARAMETERS - -### -KQLDatabaseId -(Mandatory) The ID of the KQLDatabase to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace containing the KQLDatabase to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricKQLQueryset.md b/documentation/Remove-FabricKQLQueryset.md deleted file mode 100644 index eda1fa50..00000000 --- a/documentation/Remove-FabricKQLQueryset.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricKQLQueryset - -## SYNOPSIS -Deletes an KQLQueryset from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Remove-FabricKQLQueryset [-WorkspaceId] [-KQLQuerysetId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricKQLQueryset\` function sends a DELETE request to the Fabric API to remove a specified KQLQueryset from a given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricKQLQueryset -WorkspaceId "12345" -KQLQuerysetId "67890" -``` - -Deletes the KQLQueryset with ID "67890" from workspace "12345". - -## PARAMETERS - -### -KQLQuerysetId -(Mandatory) The ID of the KQLQueryset to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace containing the KQLQueryset to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricLakehouse.md b/documentation/Remove-FabricLakehouse.md deleted file mode 100644 index 3dc816a4..00000000 --- a/documentation/Remove-FabricLakehouse.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricLakehouse - -## SYNOPSIS -Deletes an Lakehouse from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Remove-FabricLakehouse [-WorkspaceId] [-LakehouseId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricLakehouse\` function sends a DELETE request to the Fabric API to remove a specified Lakehouse from a given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricLakehouse -WorkspaceId "12345" -LakehouseId "67890" -``` - -Deletes the Lakehouse with ID "67890" from workspace "12345". - -## PARAMETERS - -### -LakehouseId -(Mandatory) The ID of the Lakehouse to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace containing the Lakehouse to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricMLExperiment.md b/documentation/Remove-FabricMLExperiment.md deleted file mode 100644 index 9df20994..00000000 --- a/documentation/Remove-FabricMLExperiment.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricMLExperiment - -## SYNOPSIS -Removes an ML Experiment from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricMLExperiment [-WorkspaceId] [-MLExperimentId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove an ML Experiment -from the specified workspace using the provided WorkspaceId and MLExperimentId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" -This example removes the MLExperiment with ID "experiment-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -MLExperimentId -The unique identifier of the MLExperiment to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the MLExperiment will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricMLModel.md b/documentation/Remove-FabricMLModel.md deleted file mode 100644 index d0c02c49..00000000 --- a/documentation/Remove-FabricMLModel.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricMLModel - -## SYNOPSIS -Removes an ML Model from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricMLModel [-WorkspaceId] [-MLModelId] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove an ML Model -from the specified workspace using the provided WorkspaceId and MLModelId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" -This example removes the ML Model with ID "model-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -MLModelId -The unique identifier of the ML Model to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the ML Model will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricMirroredDatabase.md b/documentation/Remove-FabricMirroredDatabase.md deleted file mode 100644 index b83b4e37..00000000 --- a/documentation/Remove-FabricMirroredDatabase.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricMirroredDatabase - -## SYNOPSIS -Deletes an MirroredDatabase from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Remove-FabricMirroredDatabase [-WorkspaceId] [-MirroredDatabaseId] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricMirroredDatabase\` function sends a DELETE request to the Fabric API to remove a specified MirroredDatabase from a given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricMirroredDatabase -WorkspaceId "12345" -MirroredDatabaseId "67890" -``` - -Deletes the MirroredDatabase with ID "67890" from workspace "12345". - -## PARAMETERS - -### -MirroredDatabaseId -(Mandatory) The ID of the MirroredDatabase to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace containing the MirroredDatabase to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricNotebook.md b/documentation/Remove-FabricNotebook.md deleted file mode 100644 index 2937c0c9..00000000 --- a/documentation/Remove-FabricNotebook.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricNotebook - -## SYNOPSIS -Deletes an Notebook from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Remove-FabricNotebook [-WorkspaceId] [-NotebookId] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricNotebook\` function sends a DELETE request to the Fabric API to remove a specified Notebook from a given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricNotebook -WorkspaceId "12345" -NotebookId "67890" -``` - -Deletes the Notebook with ID "67890" from workspace "12345". - -## PARAMETERS - -### -NotebookId -(Mandatory) The ID of the Notebook to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace containing the Notebook to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Remove-FabricRecoveryPoint.md b/documentation/Remove-FabricRecoveryPoint.md deleted file mode 100644 index efaecf1f..00000000 --- a/documentation/Remove-FabricRecoveryPoint.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricRecoveryPoint - -## SYNOPSIS -Remove a selected Fabric Recovery Point. - -## SYNTAX - -``` -Remove-FabricRecoveryPoint [[-CreateTime] ] [[-WorkspaceGUID] ] [[-DataWarehouseGUID] ] - [[-BaseUrl] ] [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Remove a selected Fabric Recovery Point. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -``` - -Remove a specific restore point from a Fabric Data Warehouse that has been set using Set-FabricConfig. - -### EXAMPLE 2 -``` -Remove-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -``` - -Remove a specific restore point from a Fabric Data Warehouse, specifying the workspace and data warehouse GUIDs. - -## PARAMETERS - -### -BaseUrl -Defaults to api.powerbi.com - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: Api.powerbi.com -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateTime -The specific unique time of the restore point to remove. -Get this from Get-FabricRecoveryPoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataWarehouseGUID -The GUID for the data warehouse which we want to retrieve restore points for. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceGUID -This is the workspace GUID in which the data warehouse resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Jess Pomfret - -## RELATED LINKS diff --git a/documentation/Remove-FabricReflex.md b/documentation/Remove-FabricReflex.md deleted file mode 100644 index 5bdfe177..00000000 --- a/documentation/Remove-FabricReflex.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricReflex - -## SYNOPSIS -Removes an Reflex from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricReflex [-WorkspaceId] [-ReflexId] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove an Reflex -from the specified workspace using the provided WorkspaceId and ReflexId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -This example removes the Reflex with ID "Reflex-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexId -The unique identifier of the Reflex to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the Reflex will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricReport.md b/documentation/Remove-FabricReport.md deleted file mode 100644 index 755f9b10..00000000 --- a/documentation/Remove-FabricReport.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricReport - -## SYNOPSIS -Removes an Report from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricReport [-WorkspaceId] [-ReportId] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove an Report -from the specified workspace using the provided WorkspaceId and ReportId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" -This example removes the Report with ID "Report-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportId -The unique identifier of the Report to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the Report will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricSQLDatabase.md b/documentation/Remove-FabricSQLDatabase.md deleted file mode 100644 index 69713f94..00000000 --- a/documentation/Remove-FabricSQLDatabase.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricSQLDatabase - -## SYNOPSIS -Deletes a SQL Database from a specified workspace in Microsoft Fabric. - -## SYNTAX - -``` -Remove-FabricSQLDatabase [-WorkspaceId] [-SQLDatabaseId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricSQLDatabase\` function sends a DELETE request to the Fabric API to remove a specified SQLDatabase from a given workspace. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricSQLDatabas -WorkspaceId "12345" -SQLDatabaseId "67890" -``` - -Deletes the SQL Database with ID "67890" from workspace "12345". - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SQLDatabaseId -(Mandatory) The ID of the SQL Database to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The ID of the workspace containing the SQLDatabase to delete. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Validates token expiration before making the API request. - -Author: Kamil Nowinski - -## RELATED LINKS diff --git a/documentation/Remove-FabricSemanticModel.md b/documentation/Remove-FabricSemanticModel.md deleted file mode 100644 index 37531ac8..00000000 --- a/documentation/Remove-FabricSemanticModel.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricSemanticModel - -## SYNOPSIS -Removes an SemanticModel from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricSemanticModel [-WorkspaceId] [-SemanticModelId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove an SemanticModel -from the specified workspace using the provided WorkspaceId and SemanticModelId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -This example removes the SemanticModel with ID "SemanticModel-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelId -The unique identifier of the SemanticModel to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the SemanticModel will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricSparkCustomPool.md b/documentation/Remove-FabricSparkCustomPool.md deleted file mode 100644 index 76b20b8f..00000000 --- a/documentation/Remove-FabricSparkCustomPool.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricSparkCustomPool - -## SYNOPSIS -Removes a Spark custom pool from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricSparkCustomPool [-WorkspaceId] [-SparkCustomPoolId] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove a Spark custom pool -from the specified workspace using the provided WorkspaceId and SparkCustomPoolId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolId "pool-67890" -This example removes the Spark custom pool with ID "pool-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkCustomPoolId -The unique identifier of the Spark custom pool to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the Spark custom pool will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricSparkJobDefinition.md b/documentation/Remove-FabricSparkJobDefinition.md deleted file mode 100644 index 12b4116a..00000000 --- a/documentation/Remove-FabricSparkJobDefinition.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricSparkJobDefinition - -## SYNOPSIS -Removes an SparkJobDefinition from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricSparkJobDefinition [-WorkspaceId] [-SparkJobDefinitionId] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove an SparkJobDefinition -from the specified workspace using the provided WorkspaceId and SparkJobDefinitionId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -This example removes the SparkJobDefinition with ID "SparkJobDefinition-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionId -The unique identifier of the SparkJobDefinition to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the SparkJobDefinition will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricWarehouse.md b/documentation/Remove-FabricWarehouse.md deleted file mode 100644 index 5db73c75..00000000 --- a/documentation/Remove-FabricWarehouse.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricWarehouse - -## SYNOPSIS -Removes a warehouse from a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Remove-FabricWarehouse [-WorkspaceId] [-WarehouseId] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a DELETE request to the Microsoft Fabric API to remove a warehouse -from the specified workspace using the provided WorkspaceId and WarehouseId. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" -This example removes the warehouse with ID "warehouse-67890" from the workspace with ID "workspace-12345". -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarehouseId -The unique identifier of the warehouse to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the warehouse will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricWorkspace.md b/documentation/Remove-FabricWorkspace.md deleted file mode 100644 index d0a527ab..00000000 --- a/documentation/Remove-FabricWorkspace.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricWorkspace - -## SYNOPSIS -Deletes an existing Fabric workspace by its workspace ID. - -## SYNTAX - -``` -Remove-FabricWorkspace [-WorkspaceId] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Remove-FabricWorkspace\` function deletes a workspace in the Fabric platform by sending a DELETE request to the API. -It validates the workspace ID and handles both success and error responses. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricWorkspace -WorkspaceId "workspace123" -``` - -Deletes the workspace with the ID "workspace123". - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricWorkspaceCapacityAssignment.md b/documentation/Remove-FabricWorkspaceCapacityAssignment.md deleted file mode 100644 index fa9e2eb8..00000000 --- a/documentation/Remove-FabricWorkspaceCapacityAssignment.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricWorkspaceCapacityAssignment - -## SYNOPSIS -Unassigns a Fabric workspace from its capacity. - -## SYNTAX - -``` -Remove-FabricWorkspaceCapacityAssignment [-WorkspaceId] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricWorkspaceCapacityAssignment\` function sends a POST request to unassign a workspace from its assigned capacity. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricWorkspaceCapacityAssignment -WorkspaceId "workspace123" -``` - -Unassigns the workspace with ID "workspace123" from its capacity. - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace to be unassigned from its capacity. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricWorkspaceIdentity.md b/documentation/Remove-FabricWorkspaceIdentity.md deleted file mode 100644 index 9819813d..00000000 --- a/documentation/Remove-FabricWorkspaceIdentity.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricWorkspaceIdentity - -## SYNOPSIS -Deprovisions the Managed Identity for a specified Fabric workspace. - -## SYNTAX - -``` -Remove-FabricWorkspaceIdentity [-WorkspaceId] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Remove-FabricWorkspaceCapacity\` function deprovisions the Managed Identity from the given workspace by calling the appropriate API endpoint. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricWorkspaceCapacity -WorkspaceId "workspace123" -``` - -Deprovisions the Managed Identity for the workspace with ID "workspace123". - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace from which the identity will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Remove-FabricWorkspaceRoleAssignment.md b/documentation/Remove-FabricWorkspaceRoleAssignment.md deleted file mode 100644 index dafc680a..00000000 --- a/documentation/Remove-FabricWorkspaceRoleAssignment.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Remove-FabricWorkspaceRoleAssignment - -## SYNOPSIS -Removes a role assignment from a Fabric workspace. - -## SYNTAX - -``` -Remove-FabricWorkspaceRoleAssignment [-WorkspaceId] [-WorkspaceRoleAssignmentId] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Remove-FabricWorkspaceRoleAssignment\` function deletes a specific role assignment from a Fabric workspace by making a DELETE request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "role123" -``` - -Removes the role assignment with the ID "role123" from the workspace "workspace123". - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceRoleAssignmentId -The unique identifier of the role assignment to be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Restore-FabricRecoveryPoint.md b/documentation/Restore-FabricRecoveryPoint.md deleted file mode 100644 index 4eaf0ea0..00000000 --- a/documentation/Restore-FabricRecoveryPoint.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Restore-FabricRecoveryPoint - -## SYNOPSIS -Restore a Fabric data warehouse to a specified restore pont. - -## SYNTAX - -``` -Restore-FabricRecoveryPoint [[-CreateTime] ] [[-WorkspaceGUID] ] [[-DataWarehouseGUID] ] - [[-BaseUrl] ] [-Wait] [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Restore a Fabric data warehouse to a specified restore pont. - -## EXAMPLES - -### EXAMPLE 1 -``` -Restore-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -``` - -Restore a Fabric Data Warehouse to a specific restore point that has been set using Set-FabricConfig. - -### EXAMPLE 2 -``` -Restore-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -``` - -Restore a Fabric Data Warehouse to a specific restore point, specifying the workspace and data warehouse GUIDs. - -## PARAMETERS - -### -BaseUrl -Defaults to api.powerbi.com - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: Api.powerbi.com -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateTime -The specific unique time of the restore point to remove. -Get this from Get-FabricRecoveryPoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataWarehouseGUID -The GUID for the data warehouse which we want to retrieve restore points for. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Wait for the restore to complete before returning. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceGUID -This is the workspace GUID in which the data warehouse resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Jess Pomfret - -## RELATED LINKS diff --git a/documentation/Resume-FabricCapacity.md b/documentation/Resume-FabricCapacity.md deleted file mode 100644 index 07471d80..00000000 --- a/documentation/Resume-FabricCapacity.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Resume-FabricCapacity - -## SYNOPSIS -Resumes a capacity. - -## SYNTAX - -``` -Resume-FabricCapacity [-subscriptionID] [-resourcegroup] [-capacity] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Resume-FabricCapacity function resumes a capacity. -It supports multiple aliases for flexibility. - -## EXAMPLES - -### EXAMPLE 1 -``` -Resume-FabricCapacity -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" -``` - -This example resumes a capacity given the subscription ID, resource group, and capacity. - -## PARAMETERS - -### -capacity -The capacity. -This is a mandatory parameter. -This is a parameter found in Azure, not Fabric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -resourcegroup -The resource group. -This is a mandatory parameter. -This is a parameter found in Azure, not Fabric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -subscriptionID -The the ID of the subscription. -This is a mandatory parameter. -This is a parameter found in Azure, not Fabric. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -The function defines parameters for the subscription ID, resource group, and capacity. -If the 'azToken' environment variable is null, it connects to the Azure account and sets the 'azToken' environment variable. -It then defines the headers for the request, defines the URI for the request, and makes a GET request to the URI. - -Author: Ioana Bouariu - -## RELATED LINKS diff --git a/documentation/Revoke-FabricCapacityTenantSettingOverrides.md b/documentation/Revoke-FabricCapacityTenantSettingOverrides.md deleted file mode 100644 index a7a457c1..00000000 --- a/documentation/Revoke-FabricCapacityTenantSettingOverrides.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Revoke-FabricCapacityTenantSettingOverrides - -## SYNOPSIS -Removes a tenant setting override from a specific capacity in the Fabric tenant. - -## SYNTAX - -``` -Revoke-FabricCapacityTenantSettingOverrides [-CapacityId] [-tenantSettingName] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Revoke-FabricCapacityTenantSettingOverrides\` function deletes a specific tenant setting override for a given capacity in the Fabric tenant by making a DELETE request to the appropriate API endpoint. - -## EXAMPLES - -### EXAMPLE 1 -``` -Revoke-FabricCapacityTenantSettingOverrides -capacityId "12345" -tenantSettingName "ExampleSetting" -``` - -Removes the tenant setting override named "ExampleSetting" from the capacity with ID "12345". - -## PARAMETERS - -### -CapacityId -The unique identifier of the capacity from which the tenant setting override will be removed. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -tenantSettingName -The name of the tenant setting override to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Revoke-FabricExternalDataShares.md b/documentation/Revoke-FabricExternalDataShares.md deleted file mode 100644 index 1de471a8..00000000 --- a/documentation/Revoke-FabricExternalDataShares.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Revoke-FabricExternalDataShares - -## SYNOPSIS -Retrieves External Data Shares details from a specified Microsoft Fabric. - -## SYNTAX - -``` -Revoke-FabricExternalDataShares [-WorkspaceId] [-ItemId] [-ExternalDataShareId] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function retrieves External Data Shares details. -It handles token validation, constructs the API URL, makes the API request, and processes the response. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-FabricExternalDataShares -This example retrieves the External Data Shares details -``` - -## PARAMETERS - -### -ExternalDataShareId -The unique identifier of the External Data Share to be retrieved. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemId -The unique identifier of the item associated with the External Data Shares. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the External Data Shares resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Set-FabricConfig.md b/documentation/Set-FabricConfig.md deleted file mode 100644 index ca162a55..00000000 --- a/documentation/Set-FabricConfig.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Set-FabricConfig - -## SYNOPSIS -Register the configuration for use with all functions in the PSFabricTools module. - -## SYNTAX - -``` -Set-FabricConfig [[-WorkspaceGUID] ] [[-DataWarehouseGUID] ] [[-BaseUrl] ] [-SkipPersist] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Register the configuration for use with all functions in the PSFabricTools module. - -## EXAMPLES - -### EXAMPLE 1 -``` -Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -``` - -Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module. - -### EXAMPLE 2 -``` -Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -SkipPersist -``` - -Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module - but it does not persist the values, only uses them for the current session. - -## PARAMETERS - -### -BaseUrl -Defaults to api.powerbi.com - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: Api.powerbi.com -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataWarehouseGUID -The GUID for the Data Warehouse which we want to retrieve restore points for. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipPersist -If set, the configuration will not be persisted to the registry. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceGUID -This is the workspace GUID in which the Data Warehouse resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Jess Pomfret - -## RELATED LINKS diff --git a/documentation/Start-FabricLakehouseTableMaintenance.md b/documentation/Start-FabricLakehouseTableMaintenance.md deleted file mode 100644 index c37c6370..00000000 --- a/documentation/Start-FabricLakehouseTableMaintenance.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Start-FabricLakehouseTableMaintenance - -## SYNOPSIS -Initiates a table maintenance job for a specified Lakehouse in a Fabric workspace. - -## SYNTAX - -``` -Start-FabricLakehouseTableMaintenance [-WorkspaceId] [-LakehouseId] [[-JobType] ] - [[-SchemaName] ] [[-TableName] ] [[-IsVOrder] ] [[-ColumnsZOrderBy] ] - [[-retentionPeriod] ] [[-waitForCompletion] ] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Fabric API to start a table maintenance job for a specified Lakehouse. -It allows for optional parameters such as schema name, table name, and Z-ordering columns. -The function also handles asynchronous operations and can wait for completion if specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -Start-FabricLakehouseTableMaintenance -WorkspaceId "12345" -LakehouseId "67890" -JobType "TableMaintenance" -SchemaName "dbo" -TableName "MyTable" -IsVOrder $true -ColumnsZOrderBy @("Column1", "Column2") -retentionPeriod "7:00:00" -waitForCompletion $true -Initiates a table maintenance job for the specified Lakehouse and waits for its completion. -``` - -### EXAMPLE 2 -``` -Start-FabricLakehouseTableMaintenance -WorkspaceId "12345" -LakehouseId "67890" -JobType "TableMaintenance" -SchemaName "dbo" -TableName "MyTable" -IsVOrder $false -ColumnsZOrderBy @("Column1", "Column2") -retentionPeriod "7:00:00" -Initiates a table maintenance job for the specified Lakehouse without waiting for its completion. -``` - -## PARAMETERS - -### -ColumnsZOrderBy -An array of columns to be used for Z-ordering. -This parameter is optional. - -```yaml -Type: System.Array -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsVOrder -A boolean flag indicating whether to apply V-ordering. -This parameter is optional. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobType -The type of job to be initiated. -Default is "TableMaintenance". -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: TableMaintenance -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LakehouseId -The unique identifier of the Lakehouse for which the table maintenance job is to be initiated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -retentionPeriod -The retention period for the table maintenance job. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SchemaName -The name of the schema in the Lakehouse. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TableName -The name of the table in the Lakehouse. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -waitForCompletion -A boolean flag indicating whether to wait for the job to complete. -Default is false. -This parameter is optional. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Lakehouse resides. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- This function handles asynchronous operations and retrieves operation results if required. -- The function uses the \`Write-Message\` function for logging and debugging purposes. -- The function uses the \`Get-FabricLakehouse\` function to retrieve Lakehouse details. -- The function uses the \`Get-FabricLongRunningOperation\` function to check the status of long-running operations. -- The function uses the \`Invoke-RestMethod\` cmdlet to make API requests. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Start-FabricMirroredDatabaseMirroring.md b/documentation/Start-FabricMirroredDatabaseMirroring.md deleted file mode 100644 index 10752f9c..00000000 --- a/documentation/Start-FabricMirroredDatabaseMirroring.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Start-FabricMirroredDatabaseMirroring - -## SYNOPSIS -Starts the mirroring of a specified mirrored database in a given workspace. - -## SYNTAX - -``` -Start-FabricMirroredDatabaseMirroring [-WorkspaceId] [[-MirroredDatabaseId] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to start the mirroring of a specified mirrored database. -It requires the workspace ID and the mirrored database ID as parameters. - -## EXAMPLES - -### EXAMPLE 1 -``` -Start-FabricMirroredDatabaseMirroring -WorkspaceId "12345" -MirroredDatabaseId "67890" -Starts the mirroring of the mirrored database with ID `67890` in the workspace `12345`. -``` - -## PARAMETERS - -### -MirroredDatabaseId -The unique identifier of the mirrored database to be started. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the mirrored database resides. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- This function handles asynchronous operations and retrieves operation results if required. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Start-FabricSparkJobDefinitionOnDemand.md b/documentation/Start-FabricSparkJobDefinitionOnDemand.md deleted file mode 100644 index 42b322ce..00000000 --- a/documentation/Start-FabricSparkJobDefinitionOnDemand.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Start-FabricSparkJobDefinitionOnDemand - -## SYNOPSIS -Starts a Fabric Spark Job Definition on demand. - -## SYNTAX - -``` -Start-FabricSparkJobDefinitionOnDemand [-WorkspaceId] [-SparkJobDefinitionId] - [[-JobType] ] [[-waitForCompletion] ] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This function initiates a Spark Job Definition on demand within a specified workspace. -It constructs the appropriate API endpoint URL and makes a POST request to start the job. -The function can optionally wait for the job to complete based on the 'waitForCompletion' parameter. - -## EXAMPLES - -### EXAMPLE 1 -``` -Start-FabricSparkJobDefinitionOnDemand -WorkspaceId "workspace123" -SparkJobDefinitionId "jobdef456" -waitForCompletion $true -``` - -## PARAMETERS - -### -JobType -The type of job to be started. -The default value is 'sparkjob'. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: Sparkjob -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionId -The ID of the Spark Job Definition to be started. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -waitForCompletion -A boolean flag indicating whether to wait for the job to complete. -The default value is $false. -This parameter is optional. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace where the Spark Job Definition is located. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Ensure that the necessary authentication tokens are valid before running this function. -The function logs detailed messages for debugging and informational purposes. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Stop-FabricEnvironmentPublish.md b/documentation/Stop-FabricEnvironmentPublish.md deleted file mode 100644 index 7d85a54b..00000000 --- a/documentation/Stop-FabricEnvironmentPublish.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Stop-FabricEnvironmentPublish - -## SYNOPSIS -Cancels the publish operation for a specified environment in Microsoft Fabric. - -## SYNTAX - -``` -Stop-FabricEnvironmentPublish [-WorkspaceId] [-EnvironmentId] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a cancel publish request to the Microsoft Fabric API for a given environment. -It ensures that the token is valid before making the request and handles both successful and error responses. - -## EXAMPLES - -### EXAMPLE 1 -``` -Stop-FabricEnvironmentPublish -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -``` - -Cancels the publish operation for the specified environment. - -## PARAMETERS - -### -EnvironmentId -The unique identifier of the environment for which the publish operation is to be canceled. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the environment exists. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Stop-FabricMirroredDatabaseMirroring.md b/documentation/Stop-FabricMirroredDatabaseMirroring.md deleted file mode 100644 index e7007b94..00000000 --- a/documentation/Stop-FabricMirroredDatabaseMirroring.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Stop-FabricMirroredDatabaseMirroring - -## SYNOPSIS -Stops the mirroring of a specified mirrored database in a given workspace. - -## SYNTAX - -``` -Stop-FabricMirroredDatabaseMirroring [-WorkspaceId] [[-MirroredDatabaseId] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a POST request to the Microsoft Fabric API to stop the mirroring of a specified mirrored database. -It requires the workspace ID and the mirrored database ID as parameters. - -## EXAMPLES - -### EXAMPLE 1 -``` -Stop-FabricMirroredDatabaseMirroring -WorkspaceId "12345" -MirroredDatabaseId "67890" -Stops the mirroring of the mirrored database with ID `67890` in the workspace `12345`. -``` - -## PARAMETERS - -### -MirroredDatabaseId -The unique identifier of the mirrored database to be stopped. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the mirrored database resides. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- This function handles asynchronous operations and retrieves operation results if required. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Suspend-FabricCapacity.md b/documentation/Suspend-FabricCapacity.md deleted file mode 100644 index 69d4ddd3..00000000 --- a/documentation/Suspend-FabricCapacity.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Suspend-FabricCapacity - -## SYNOPSIS -Suspends a capacity. - -## SYNTAX - -``` -Suspend-FabricCapacity [-subscriptionID] [-resourcegroup] [-capacity] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Suspend-FabricCapacity function suspends a capacity. -It supports multiple aliases for flexibility. - -## EXAMPLES - -### EXAMPLE 1 -``` -Suspend-FabricCapacity -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" -``` - -This example suspends a capacity given the subscription ID, resource group, and capacity. - -## PARAMETERS - -### -capacity -The the capacity. -This is a mandatory parameter. -This is a parameter found in Azure, not Fabric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -resourcegroup -The resource group. -This is a mandatory parameter. -This is a parameter found in Azure, not Fabric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -subscriptionID -The ID of the subscription. -This is a mandatory parameter. -This is a parameter found in Azure, not Fabric. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -The function defines parameters for the subscription ID, resource group, and capacity. -If the 'azToken' environment variable is null, it connects to the Azure account and sets the 'azToken' environment variable. -It then defines the headers for the request, defines the URI for the request, and makes a GET request to the URI. - -Author: Ioana Bouariu - -## RELATED LINKS diff --git a/documentation/Unregister-FabricWorkspaceToCapacity.md b/documentation/Unregister-FabricWorkspaceToCapacity.md deleted file mode 100644 index ac5f6681..00000000 --- a/documentation/Unregister-FabricWorkspaceToCapacity.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Unregister-FabricWorkspaceToCapacity - -## SYNOPSIS -Unregisters a workspace from a capacity. - -## SYNTAX - -### WorkspaceId -``` -Unregister-FabricWorkspaceToCapacity -WorkspaceId [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -### WorkspaceObject -``` -Unregister-FabricWorkspaceToCapacity -Workspace [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The Unregister-FabricWorkspaceToCapacity function unregisters a workspace from a capacity in PowerBI. -It can be used to remove a workspace from a capacity, allowing it to be assigned to a different capacity or remain unassigned. - -## EXAMPLES - -### EXAMPLE 1 -``` -Unregister-FabricWorkspaceToCapacity -WorkspaceId "12345678" -Unregisters the workspace with ID "12345678" from the capacity. -``` - -### EXAMPLE 2 -``` -Get-FabricWorkspace | Unregister-FabricWorkspaceToCapacity -Unregisters the workspace objects piped from Get-FabricWorkspace from the capacity. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Workspace -Specifies the workspace object to be unregistered from the capacity. -This parameter is mandatory when using the 'WorkspaceObject' parameter set. -The workspace object can be piped into the function. - -```yaml -Type: System.Object -Parameter Sets: WorkspaceObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceId -Specifies the ID of the workspace to be unregistered from the capacity. -This parameter is mandatory when using the 'WorkspaceId' parameter set. - -```yaml -Type: System.Guid -Parameter Sets: WorkspaceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSCustomObject -## OUTPUTS - -### System.Object -## NOTES -Author: Ioana Bouariu - -## RELATED LINKS diff --git a/documentation/Update-FabricCapacityTenantSettingOverrides.md b/documentation/Update-FabricCapacityTenantSettingOverrides.md deleted file mode 100644 index 9a8a1681..00000000 --- a/documentation/Update-FabricCapacityTenantSettingOverrides.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricCapacityTenantSettingOverrides - -## SYNOPSIS -Updates tenant setting overrides for a specified capacity ID. - -## SYNTAX - -``` -Update-FabricCapacityTenantSettingOverrides [-TenantSettingName] [-EnableTenantSetting] - [[-DelegateToCapacity] ] [[-DelegateToDomain] ] [[-DelegateToWorkspace] ] - [[-EnabledSecurityGroups] ] [[-ExcludedSecurityGroups] ] [[-Properties] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Update-FabricCapacityTenantSettingOverrides\` function updates tenant setting overrides in a Fabric environment by making a POST request to the appropriate API endpoint. -It allows specifying settings such as enabling tenant settings, delegating to a workspace, and including or excluding security groups. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" -``` - -Updates the tenant setting "SomeSetting" for the capacity with ID "12345" and enables it. - -### EXAMPLE 2 -``` -Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" -EnabledSecurityGroups @(@{graphId="1";name="Group1"},@{graphId="2";name="Group2"}) -``` - -Updates the tenant setting "SomeSetting" for the capacity with ID "12345", enables it, and specifies security groups to include. - -## PARAMETERS - -### -DelegateToCapacity -{{ Fill DelegateToCapacity Description }} - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegateToDomain -{{ Fill DelegateToDomain Description }} - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegateToWorkspace -(Optional) Specifies the workspace to which the setting should be delegated. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledSecurityGroups -(Optional) A JSON array of security groups to be enabled, each containing \`graphId\` and \`name\` properties. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTenantSetting -(Mandatory) Indicates whether the tenant setting should be enabled. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedSecurityGroups -(Optional) A JSON array of security groups to be excluded, each containing \`graphId\` and \`name\` properties. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -{{ Fill Properties Description }} - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantSettingName -{{ Fill TenantSettingName Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricCopyJob.md b/documentation/Update-FabricCopyJob.md deleted file mode 100644 index db74acdb..00000000 --- a/documentation/Update-FabricCopyJob.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricCopyJob - -## SYNOPSIS -Updates an existing Copy Job in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricCopyJob [-WorkspaceId] [-CopyJobId] [-CopyJobName] - [[-CopyJobDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Sends a PATCH request to the Microsoft Fabric API to update an existing Copy Job -in the specified workspace. -Allows updating the Copy Job's name and optionally its description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "copyjob-67890" -CopyJobName "Updated Copy Job" -CopyJobDescription "Updated description" -Updates the Copy Job with ID "copyjob-67890" in the workspace "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -CopyJobDescription -An optional new description for the Copy Job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyJobId -The unique identifier of the Copy Job to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyJobName -The new name for the Copy Job. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace containing the Copy Job. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires the \`$FabricConfig\` global configuration, which includes \`BaseUrl\` and \`FabricHeaders\`. -- Ensures token validity by calling \`Confirm-TokenState\` before making the API request. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Update-FabricCopyJobDefinition.md b/documentation/Update-FabricCopyJobDefinition.md deleted file mode 100644 index d4c1e74f..00000000 --- a/documentation/Update-FabricCopyJobDefinition.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricCopyJobDefinition - -## SYNOPSIS -Updates the definition of a Copy Job in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricCopyJobDefinition [-WorkspaceId] [-CopyJobId] [-CopyJobPathDefinition] - [[-CopyJobPathPlatformDefinition] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function updates the content or metadata of a Copy Job within a Microsoft Fabric workspace. -The Copy Job content and platform-specific definitions can be provided as file paths, which will be encoded as Base64 and sent in the request. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb" -``` - -Updates the content of the Copy Job with ID \`67890\` in the workspace \`12345\` using the specified Copy Job file. - -### EXAMPLE 2 -``` -Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb" -CopyJobPathPlatformDefinition "C:\CopyJobs\Platform.json" -``` - -Updates both the content and platform-specific definition of the Copy Job with ID \`67890\` in the workspace \`12345\`. - -## PARAMETERS - -### -CopyJobId -(Mandatory) The unique identifier of the Copy Job to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyJobPathDefinition -(Mandatory) The file path to the Copy Job content definition file. -The file content will be encoded as Base64. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyJobPathPlatformDefinition -(Optional) The file path to the platform-specific definition file for the Copy Job. -The file content will be encoded as Base64. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace containing the Copy Job. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires the \`$FabricConfig\` global configuration, which must include \`BaseUrl\` and \`FabricHeaders\`. -- Validates token expiration using \`Confirm-TokenState\` before making the API request. -- Encodes file content as Base64 before sending it to the Fabric API. -- Logs detailed messages for debugging and error handling. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Update-FabricDataPipeline.md b/documentation/Update-FabricDataPipeline.md deleted file mode 100644 index 457cdb06..00000000 --- a/documentation/Update-FabricDataPipeline.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricDataPipeline - -## SYNOPSIS -Updates an existing DataPipeline in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricDataPipeline [-WorkspaceId] [-DataPipelineId] [-DataPipelineName] - [[-DataPipelineDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing DataPipeline -in the specified workspace. -It supports optional parameters for DataPipeline description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineId "pipeline-67890" -DataPipelineName "Updated DataPipeline" -DataPipelineDescription "Updated description" -This example updates the DataPipeline with ID "pipeline-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -DataPipelineDescription -An optional new description for the DataPipeline. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataPipelineId -The unique identifier of the DataPipeline to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataPipelineName -The new name of the DataPipeline. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the DataPipeline exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricDomain.md b/documentation/Update-FabricDomain.md deleted file mode 100644 index c0814bbf..00000000 --- a/documentation/Update-FabricDomain.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricDomain - -## SYNOPSIS -Updates a Fabric domain by its ID. - -## SYNTAX - -``` -Update-FabricDomain [-DomainId] [-DomainName] [[-DomainDescription] ] - [[-DomainContributorsScope] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Update-FabricDomain\` function modifies a specified domain in Microsoft Fabric using the provided parameters. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricDomain -DomainId "12345" -DomainName "NewDomain" -DomainDescription "Updated description" -DomainContributorsScope "AdminsOnly" -``` - -Updates the domain with ID "12345" with a new name, description, and contributors' scope. - -## PARAMETERS - -### -DomainContributorsScope -(Optional) The contributors' scope for the domain. -Accepted values: 'AdminsOnly', 'AllTenant', 'SpecificUsersAndGroups'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainDescription -(Optional) A new description for the domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainId -The unique identifier of the domain to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -The new name for the domain. -Must be alphanumeric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricEnvironment.md b/documentation/Update-FabricEnvironment.md deleted file mode 100644 index 2193ced1..00000000 --- a/documentation/Update-FabricEnvironment.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricEnvironment - -## SYNOPSIS -Updates the properties of a Fabric Environment. - -## SYNTAX - -``` -Update-FabricEnvironment [-WorkspaceId] [-EnvironmentId] [-EnvironmentName] - [[-EnvironmentDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Update-FabricEnvironment\` function updates the name and/or description of a specified Fabric Environment by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewEnvironmentName" -``` - -Updates the name of the Environment with the ID "Environment123" to "NewEnvironmentName". - -### EXAMPLE 2 -``` -Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewName" -EnvironmentDescription "Updated description" -``` - -Updates both the name and description of the Environment "Environment123". - -## PARAMETERS - -### -EnvironmentDescription -(Optional) The new description for the Environment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentId -The unique identifier of the Environment to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The new name for the Environment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Environment resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricEnvironmentStagingSparkCompute.md b/documentation/Update-FabricEnvironmentStagingSparkCompute.md deleted file mode 100644 index 03c24b22..00000000 --- a/documentation/Update-FabricEnvironmentStagingSparkCompute.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricEnvironmentStagingSparkCompute - -## SYNOPSIS -Updates the Spark compute configuration in the staging environment for a given workspace. - -## SYNTAX - -``` -Update-FabricEnvironmentStagingSparkCompute [-WorkspaceId] [-EnvironmentId] - [-InstancePoolName] [-InstancePoolType] [-DriverCores] [-DriverMemory] - [-ExecutorCores] [-ExecutorMemory] [-DynamicExecutorAllocationEnabled] - [-DynamicExecutorAllocationMinExecutors] [-DynamicExecutorAllocationMaxExecutors] - [-RuntimeVersion] [-SparkProperties] [-ProgressAction ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update the Spark compute settings -for a specified environment, including instance pool, driver and executor configurations, and dynamic allocation settings. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricEnvironmentStagingSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "env-67890" -InstancePoolName "pool1" -InstancePoolType "Workspace" -DriverCores 4 -DriverMemory "16GB" -ExecutorCores 8 -ExecutorMemory "32GB" -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 2 -DynamicExecutorAllocationMaxExecutors 10 -RuntimeVersion "3.1" -SparkProperties @{ "spark.executor.memoryOverhead"="4GB" } -``` - -## PARAMETERS - -### -DriverCores -The number of cores to allocate to the driver. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DriverMemory -The amount of memory to allocate to the driver. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicExecutorAllocationEnabled -Boolean flag to enable or disable dynamic executor allocation. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 9 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicExecutorAllocationMaxExecutors -The maximum number of executors when dynamic allocation is enabled. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 11 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicExecutorAllocationMinExecutors -The minimum number of executors when dynamic allocation is enabled. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 10 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentId -The unique identifier of the environment where the Spark compute settings will be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExecutorCores -The number of cores to allocate to each executor. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 7 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExecutorMemory -The amount of memory to allocate to each executor. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstancePoolName -The name of the instance pool to be used for Spark compute. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstancePoolType -The type of instance pool (either 'Workspace' or 'Capacity'). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuntimeVersion -The Spark runtime version to use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 12 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkProperties -A hashtable of additional Spark properties to configure. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: 13 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the environment exists. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricEventhouse.md b/documentation/Update-FabricEventhouse.md deleted file mode 100644 index ca6e77ec..00000000 --- a/documentation/Update-FabricEventhouse.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricEventhouse - -## SYNOPSIS -Updates an existing Eventhouse in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricEventhouse [-WorkspaceId] [-EventhouseId] [-EventhouseName] - [[-EventhouseDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing Eventhouse -in the specified workspace. -It supports optional parameters for Eventhouse description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhouseName "Updated Eventhouse" -EventhouseDescription "Updated description" -This example updates the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -EventhouseDescription -An optional new description for the Eventhouse. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventhouseId -The unique identifier of the Eventhouse to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventhouseName -The new name of the Eventhouse. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Eventhouse exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricEventhouseDefinition.md b/documentation/Update-FabricEventhouseDefinition.md deleted file mode 100644 index 9745d799..00000000 --- a/documentation/Update-FabricEventhouseDefinition.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricEventhouseDefinition - -## SYNOPSIS -Updates the definition of an existing Eventhouse in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricEventhouseDefinition [-WorkspaceId] [-EventhouseId] - [-EventhousePathDefinition] [[-EventhousePathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Eventhouse -in the specified workspace. -It supports optional parameters for Eventhouse definition and platform-specific definition. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhousePathDefinition "C:\Path\To\EventhouseDefinition.json" -This example updates the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" using the provided definition file. -``` - -## PARAMETERS - -### -EventhouseId -The unique identifier of the Eventhouse to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventhousePathDefinition -An optional path to the Eventhouse definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventhousePathPlatformDefinition -An optional path to the platform-specific definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Eventhouse exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricEventstream.md b/documentation/Update-FabricEventstream.md deleted file mode 100644 index e8824dac..00000000 --- a/documentation/Update-FabricEventstream.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricEventstream - -## SYNOPSIS -Updates the properties of a Fabric Eventstream. - -## SYNTAX - -``` -Update-FabricEventstream [-WorkspaceId] [-EventstreamId] [-EventstreamName] - [[-EventstreamDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Update-FabricEventstream\` function updates the name and/or description of a specified Fabric Eventstream by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewEventstreamName" -``` - -Updates the name of the Eventstream with the ID "Eventstream123" to "NewEventstreamName". - -### EXAMPLE 2 -``` -Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewName" -EventstreamDescription "Updated description" -``` - -Updates both the name and description of the Eventstream "Eventstream123". - -## PARAMETERS - -### -EventstreamDescription -(Optional) The new description for the Eventstream. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventstreamId -The unique identifier of the Eventstream to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventstreamName -The new name for the Eventstream. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Eventstream resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricEventstreamDefinition.md b/documentation/Update-FabricEventstreamDefinition.md deleted file mode 100644 index 41059319..00000000 --- a/documentation/Update-FabricEventstreamDefinition.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricEventstreamDefinition - -## SYNOPSIS -Updates the definition of a Eventstream in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricEventstreamDefinition [-WorkspaceId] [-EventstreamId] - [-EventstreamPathDefinition] [[-EventstreamPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function allows updating the content or metadata of a Eventstream in a Microsoft Fabric workspace. -The Eventstream content can be provided as file paths, and metadata updates can optionally be enabled. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb" -``` - -Updates the content of the Eventstream with ID \`67890\` in the workspace \`12345\` using the specified Eventstream file. - -### EXAMPLE 2 -``` -Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb" -UpdateMetadata $true -``` - -Updates both the content and metadata of the Eventstream with ID \`67890\` in the workspace \`12345\`. - -## PARAMETERS - -### -EventstreamId -(Mandatory) The unique identifier of the Eventstream to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventstreamPathDefinition -(Mandatory) The file path to the Eventstream content definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventstreamPathPlatformDefinition -(Optional) The file path to the Eventstream's platform-specific definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace where the Eventstream resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- The Eventstream content is encoded as Base64 before being sent to the Fabric API. -- This function handles asynchronous operations and retrieves operation results if required. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Update-FabricKQLDashboard.md b/documentation/Update-FabricKQLDashboard.md deleted file mode 100644 index d58d4a07..00000000 --- a/documentation/Update-FabricKQLDashboard.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricKQLDashboard - -## SYNOPSIS -Updates the properties of a Fabric KQLDashboard. - -## SYNTAX - -``` -Update-FabricKQLDashboard [-WorkspaceId] [-KQLDashboardId] [-KQLDashboardName] - [[-KQLDashboardDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Update-FabricKQLDashboard\` function updates the name and/or description of a specified Fabric KQLDashboard by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricKQLDashboard -KQLDashboardId "KQLDashboard123" -KQLDashboardName "NewKQLDashboardName" -``` - -Updates the name of the KQLDashboard with the ID "KQLDashboard123" to "NewKQLDashboardName". - -### EXAMPLE 2 -``` -Update-FabricKQLDashboard -KQLDashboardId "KQLDashboard123" -KQLDashboardName "NewName" -KQLDashboardDescription "Updated description" -``` - -Updates both the name and description of the KQLDashboard "KQLDashboard123". - -## PARAMETERS - -### -KQLDashboardDescription -(Optional) The new description for the KQLDashboard. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDashboardId -The unique identifier of the KQLDashboard to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDashboardName -The new name for the KQLDashboard. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the KQLDashboard exists. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricKQLDashboardDefinition.md b/documentation/Update-FabricKQLDashboardDefinition.md deleted file mode 100644 index 97a34766..00000000 --- a/documentation/Update-FabricKQLDashboardDefinition.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricKQLDashboardDefinition - -## SYNOPSIS -Updates the definition of a KQLDashboard in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricKQLDashboardDefinition [-WorkspaceId] [-KQLDashboardId] - [-KQLDashboardPathDefinition] [[-KQLDashboardPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function allows updating the content or metadata of a KQLDashboard in a Microsoft Fabric workspace. -The KQLDashboard content can be provided as file paths, and metadata updates can optionally be enabled. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb" -``` - -Updates the content of the KQLDashboard with ID \`67890\` in the workspace \`12345\` using the specified KQLDashboard file. - -### EXAMPLE 2 -``` -Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb" -``` - -Updates both the content and metadata of the KQLDashboard with ID \`67890\` in the workspace \`12345\`. - -## PARAMETERS - -### -KQLDashboardId -(Mandatory) The unique identifier of the KQLDashboard to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDashboardPathDefinition -(Mandatory) The file path to the KQLDashboard content definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDashboardPathPlatformDefinition -(Optional) The file path to the KQLDashboard's platform-specific definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace where the KQLDashboard resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- The KQLDashboard content is encoded as Base64 before being sent to the Fabric API. -- This function handles asynchronous operations and retrieves operation results if required. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Update-FabricKQLDatabase.md b/documentation/Update-FabricKQLDatabase.md deleted file mode 100644 index 6ae4eacb..00000000 --- a/documentation/Update-FabricKQLDatabase.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricKQLDatabase - -## SYNOPSIS -Updates the properties of a Fabric KQLDatabase. - -## SYNTAX - -``` -Update-FabricKQLDatabase [-WorkspaceId] [-KQLDatabaseId] [-KQLDatabaseName] - [[-KQLDatabaseDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Update-FabricKQLDatabase\` function updates the name and/or description of a specified Fabric KQLDatabase by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewKQLDatabaseName" -``` - -Updates the name of the KQLDatabase with the ID "KQLDatabase123" to "NewKQLDatabaseName". - -### EXAMPLE 2 -``` -Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewName" -KQLDatabaseDescription "Updated description" -``` - -Updates both the name and description of the KQLDatabase "KQLDatabase123". - -## PARAMETERS - -### -KQLDatabaseDescription -(Optional) The new description for the KQLDatabase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabaseId -The unique identifier of the KQLDatabase to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabaseName -The new name for the KQLDatabase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the KQLDatabase resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricKQLDatabaseDefinition.md b/documentation/Update-FabricKQLDatabaseDefinition.md deleted file mode 100644 index a4d28c8e..00000000 --- a/documentation/Update-FabricKQLDatabaseDefinition.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricKQLDatabaseDefinition - -## SYNOPSIS -Updates the definition of a KQLDatabase in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricKQLDatabaseDefinition [-WorkspaceId] [-KQLDatabaseId] - [-KQLDatabasePathDefinition] [[-KQLDatabasePathPlatformDefinition] ] - [[-KQLDatabasePathSchemaDefinition] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function allows updating the content or metadata of a KQLDatabase in a Microsoft Fabric workspace. -The KQLDatabase content can be provided as file paths, and metadata updates can optionally be enabled. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" -KQLDatabasePathDefinition "C:\KQLDatabases\KQLDatabase.ipynb" -``` - -Updates the content of the KQLDatabase with ID \`67890\` in the workspace \`12345\` using the specified KQLDatabase file. - -### EXAMPLE 2 -``` -Update-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" -KQLDatabasePathDefinition "C:\KQLDatabases\KQLDatabase.ipynb" -UpdateMetadata $true -``` - -Updates both the content and metadata of the KQLDatabase with ID \`67890\` in the workspace \`12345\`. - -## PARAMETERS - -### -KQLDatabaseId -(Mandatory) The unique identifier of the KQLDatabase to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabasePathDefinition -(Mandatory) The file path to the KQLDatabase content definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabasePathPlatformDefinition -(Optional) The file path to the KQLDatabase's platform-specific definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLDatabasePathSchemaDefinition -(Optional) The file path to the KQLDatabase's schema definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace where the KQLDatabase resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- The KQLDatabase content is encoded as Base64 before being sent to the Fabric API. -- This function handles asynchronous operations and retrieves operation results if required. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Update-FabricKQLQueryset.md b/documentation/Update-FabricKQLQueryset.md deleted file mode 100644 index a9801810..00000000 --- a/documentation/Update-FabricKQLQueryset.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricKQLQueryset - -## SYNOPSIS -Updates the properties of a Fabric KQLQueryset. - -## SYNTAX - -``` -Update-FabricKQLQueryset [-WorkspaceId] [-KQLQuerysetId] [-KQLQuerysetName] - [[-KQLQuerysetDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Update-FabricKQLQueryset\` function updates the name and/or description of a specified Fabric KQLQueryset by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricKQLQueryset -KQLQuerysetId "KQLQueryset123" -KQLQuerysetName "NewKQLQuerysetName" -``` - -Updates the name of the KQLQueryset with the ID "KQLQueryset123" to "NewKQLQuerysetName". - -### EXAMPLE 2 -``` -Update-FabricKQLQueryset -KQLQuerysetId "KQLQueryset123" -KQLQuerysetName "NewName" -KQLQuerysetDescription "Updated description" -``` - -Updates both the name and description of the KQLQueryset "KQLQueryset123". - -## PARAMETERS - -### -KQLQuerysetDescription -(Optional) The new description for the KQLQueryset. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLQuerysetId -The unique identifier of the KQLQueryset to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLQuerysetName -The new name for the KQLQueryset. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the KQLQueryset exists. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricKQLQuerysetDefinition.md b/documentation/Update-FabricKQLQuerysetDefinition.md deleted file mode 100644 index b834a1aa..00000000 --- a/documentation/Update-FabricKQLQuerysetDefinition.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricKQLQuerysetDefinition - -## SYNOPSIS -Updates the definition of a KQLQueryset in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricKQLQuerysetDefinition [-WorkspaceId] [-KQLQuerysetId] - [-KQLQuerysetPathDefinition] [[-KQLQuerysetPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function allows updating the content or metadata of a KQLQueryset in a Microsoft Fabric workspace. -The KQLQueryset content can be provided as file paths, and metadata updates can optionally be enabled. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" -KQLQuerysetPathDefinition "C:\KQLQuerysets\KQLQueryset.ipynb" -``` - -Updates the content of the KQLQueryset with ID \`67890\` in the workspace \`12345\` using the specified KQLQueryset file. - -### EXAMPLE 2 -``` -Update-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" -KQLQuerysetPathDefinition "C:\KQLQuerysets\KQLQueryset.ipynb" -``` - -Updates both the content and metadata of the KQLQueryset with ID \`67890\` in the workspace \`12345\`. - -## PARAMETERS - -### -KQLQuerysetId -(Mandatory) The unique identifier of the KQLQueryset to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLQuerysetPathDefinition -(Mandatory) The file path to the KQLQueryset content definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KQLQuerysetPathPlatformDefinition -(Optional) The file path to the KQLQueryset's platform-specific definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace where the KQLQueryset resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- The KQLQueryset content is encoded as Base64 before being sent to the Fabric API. -- This function handles asynchronous operations and retrieves operation results if required. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Update-FabricLakehouse.md b/documentation/Update-FabricLakehouse.md deleted file mode 100644 index e22bde5c..00000000 --- a/documentation/Update-FabricLakehouse.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricLakehouse - -## SYNOPSIS -Updates the properties of a Fabric Lakehouse. - -## SYNTAX - -``` -Update-FabricLakehouse [-WorkspaceId] [-LakehouseId] [-LakehouseName] - [[-LakehouseDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Update-FabricLakehouse\` function updates the name and/or description of a specified Fabric Lakehouse by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewLakehouseName" -``` - -Updates the name of the Lakehouse with the ID "Lakehouse123" to "NewLakehouseName". - -### EXAMPLE 2 -``` -Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewName" -LakehouseDescription "Updated description" -``` - -Updates both the name and description of the Lakehouse "Lakehouse123". - -## PARAMETERS - -### -LakehouseDescription -(Optional) The new description for the Lakehouse. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LakehouseId -The unique identifier of the Lakehouse to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LakehouseName -The new name for the Lakehouse. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Lakehouse exists. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricMLExperiment.md b/documentation/Update-FabricMLExperiment.md deleted file mode 100644 index 5aea1f07..00000000 --- a/documentation/Update-FabricMLExperiment.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricMLExperiment - -## SYNOPSIS -Updates an existing ML Experiment in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricMLExperiment [-WorkspaceId] [-MLExperimentId] [-MLExperimentName] - [[-MLExperimentDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing ML Experiment -in the specified workspace. -It supports optional parameters for ML Experiment description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" -MLExperimentName "Updated ML Experiment" -MLExperimentDescription "Updated description" -This example updates the ML Experiment with ID "experiment-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -MLExperimentDescription -An optional new description for the ML Experiment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MLExperimentId -The unique identifier of the ML Experiment to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MLExperimentName -The new name of the ML Experiment. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the ML Experiment exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricMLModel.md b/documentation/Update-FabricMLModel.md deleted file mode 100644 index 9ee57f0b..00000000 --- a/documentation/Update-FabricMLModel.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricMLModel - -## SYNOPSIS -Updates an existing ML Model in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricMLModel [-WorkspaceId] [-MLModelId] [[-MLModelDescription] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing ML Model -in the specified workspace. -It supports optional parameters for ML Model description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" -MLModelName "Updated ML Model" -MLModelDescription "Updated description" -This example updates the ML Model with ID "model-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -MLModelDescription -New description for the ML Model. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MLModelId -The unique identifier of the ML Model to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the ML Model exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricMirroredDatabase.md b/documentation/Update-FabricMirroredDatabase.md deleted file mode 100644 index 8e316ec1..00000000 --- a/documentation/Update-FabricMirroredDatabase.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricMirroredDatabase - -## SYNOPSIS -Updates the properties of a Fabric MirroredDatabase. - -## SYNTAX - -``` -Update-FabricMirroredDatabase [-WorkspaceId] [-MirroredDatabaseId] - [-MirroredDatabaseName] [[-MirroredDatabaseDescription] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Update-FabricMirroredDatabase\` function updates the name and/or description of a specified Fabric MirroredDatabase by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewMirroredDatabaseName" -``` - -Updates the name of the MirroredDatabase with the ID "MirroredDatabase123" to "NewMirroredDatabaseName". - -### EXAMPLE 2 -``` -Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewName" -MirroredDatabaseDescription "Updated description" -``` - -Updates both the name and description of the MirroredDatabase "MirroredDatabase123". - -## PARAMETERS - -### -MirroredDatabaseDescription -(Optional) The new description for the MirroredDatabase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MirroredDatabaseId -The unique identifier of the MirroredDatabase to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MirroredDatabaseName -The new name for the MirroredDatabase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace where the MirroredDatabase resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricMirroredDatabaseDefinition.md b/documentation/Update-FabricMirroredDatabaseDefinition.md deleted file mode 100644 index a65189cd..00000000 --- a/documentation/Update-FabricMirroredDatabaseDefinition.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricMirroredDatabaseDefinition - -## SYNOPSIS -Updates the definition of a MirroredDatabase in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricMirroredDatabaseDefinition [-WorkspaceId] [-MirroredDatabaseId] - [-MirroredDatabasePathDefinition] [[-MirroredDatabasePathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function allows updating the content or metadata of a MirroredDatabase in a Microsoft Fabric workspace. -The MirroredDatabase content can be provided as file paths, and metadata updates can optionally be enabled. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" -MirroredDatabasePathDefinition "C:\MirroredDatabases\MirroredDatabase.json" -``` - -Updates the content of the MirroredDatabase with ID \`67890\` in the workspace \`12345\` using the specified MirroredDatabase file. - -### EXAMPLE 2 -``` -Update-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" -MirroredDatabasePathDefinition "C:\MirroredDatabases\MirroredDatabase.json" -UpdateMetadata $true -``` - -Updates both the content and metadata of the MirroredDatabase with ID \`67890\` in the workspace \`12345\`. - -## PARAMETERS - -### -MirroredDatabaseId -(Mandatory) The unique identifier of the MirroredDatabase to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MirroredDatabasePathDefinition -(Mandatory) The file path to the MirroredDatabase content definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MirroredDatabasePathPlatformDefinition -(Optional) The file path to the MirroredDatabase's platform-specific definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace where the MirroredDatabase resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- The MirroredDatabase content is encoded as Base64 before being sent to the Fabric API. -- This function handles asynchronous operations and retrieves operation results if required. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Update-FabricNotebook.md b/documentation/Update-FabricNotebook.md deleted file mode 100644 index 652579ac..00000000 --- a/documentation/Update-FabricNotebook.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricNotebook - -## SYNOPSIS -Updates the properties of a Fabric Notebook. - -## SYNTAX - -``` -Update-FabricNotebook [-WorkspaceId] [-NotebookId] [-NotebookName] - [[-NotebookDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The \`Update-FabricNotebook\` function updates the name and/or description of a specified Fabric Notebook by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewNotebookName" -``` - -Updates the name of the Notebook with the ID "Notebook123" to "NewNotebookName". - -### EXAMPLE 2 -``` -Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewName" -NotebookDescription "Updated description" -``` - -Updates both the name and description of the Notebook "Notebook123". - -## PARAMETERS - -### -NotebookDescription -(Optional) The new description for the Notebook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookId -The unique identifier of the Notebook to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookName -The new name for the Notebook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Notebook exists. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricNotebookDefinition.md b/documentation/Update-FabricNotebookDefinition.md deleted file mode 100644 index 54175c0d..00000000 --- a/documentation/Update-FabricNotebookDefinition.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricNotebookDefinition - -## SYNOPSIS -Updates the definition of a notebook in a Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricNotebookDefinition [-WorkspaceId] [-NotebookId] [-NotebookPathDefinition] - [[-NotebookPathPlatformDefinition] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function allows updating the content or metadata of a notebook in a Microsoft Fabric workspace. -The notebook content can be provided as file paths, and metadata updates can optionally be enabled. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" -NotebookPathDefinition "C:\Notebooks\Notebook.ipynb" -``` - -Updates the content of the notebook with ID \`67890\` in the workspace \`12345\` using the specified notebook file. - -### EXAMPLE 2 -``` -Update-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" -NotebookPathDefinition "C:\Notebooks\Notebook.ipynb" -NotebookPathPlatformDefinition "C:\Notebooks\.platform" -``` - -Updates both the content and metadata of the notebook with ID \`67890\` in the workspace \`12345\`. - -## PARAMETERS - -### -NotebookId -(Mandatory) The unique identifier of the notebook to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookPathDefinition -(Mandatory) The file path to the notebook content definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotebookPathPlatformDefinition -(Optional) The file path to the notebook's platform-specific definition file. -The content will be encoded as Base64 and sent in the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -(Mandatory) The unique identifier of the workspace where the notebook resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`. -- Calls \`Confirm-TokenState\` to ensure token validity before making the API request. -- The notebook content is encoded as Base64 before being sent to the Fabric API. -- This function handles asynchronous operations and retrieves operation results if required. - -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/Update-FabricPaginatedReport.md b/documentation/Update-FabricPaginatedReport.md deleted file mode 100644 index b0fb9768..00000000 --- a/documentation/Update-FabricPaginatedReport.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricPaginatedReport - -## SYNOPSIS -Updates an existing paginated report in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricPaginatedReport [-WorkspaceId] [-PaginatedReportId] [-PaginatedReportName] - [[-PaginatedReportDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing paginated report -in the specified workspace. -It supports optional parameters for paginated report description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricPaginatedReport -WorkspaceId "workspace-12345" -PaginatedReportId "report-67890" -PaginatedReportName "Updated Paginated Report" -PaginatedReportDescription "Updated description" -This example updates the paginated report with ID "report-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -PaginatedReportDescription -An optional new description for the paginated report. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PaginatedReportId -The unique identifier of the paginated report to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PaginatedReportName -The new name of the paginated report. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the paginated report exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricReflex.md b/documentation/Update-FabricReflex.md deleted file mode 100644 index 2fdf4bde..00000000 --- a/documentation/Update-FabricReflex.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricReflex - -## SYNOPSIS -Updates an existing Reflex in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricReflex [-WorkspaceId] [-ReflexId] [-ReflexName] - [[-ReflexDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing Reflex -in the specified workspace. -It supports optional parameters for Reflex description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexName "Updated Reflex" -ReflexDescription "Updated description" -This example updates the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexDescription -An optional new description for the Reflex. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexId -The unique identifier of the Reflex to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexName -The new name of the Reflex. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Reflex exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricReflexDefinition.md b/documentation/Update-FabricReflexDefinition.md deleted file mode 100644 index c5724c55..00000000 --- a/documentation/Update-FabricReflexDefinition.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricReflexDefinition - -## SYNOPSIS -Updates the definition of an existing Reflex in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricReflexDefinition [-WorkspaceId] [-ReflexId] [-ReflexPathDefinition] - [[-ReflexPathPlatformDefinition] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Reflex -in the specified workspace. -It supports optional parameters for Reflex definition and platform-specific definition. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexPathDefinition "C:\Path\To\ReflexDefinition.json" -This example updates the definition of the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345" using the provided definition file. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexId -The unique identifier of the Reflex to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexPathDefinition -An optional path to the Reflex definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReflexPathPlatformDefinition -An optional path to the platform-specific definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Reflex exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricReport.md b/documentation/Update-FabricReport.md deleted file mode 100644 index 22df412e..00000000 --- a/documentation/Update-FabricReport.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricReport - -## SYNOPSIS -Updates an existing Report in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricReport [-WorkspaceId] [-ReportId] [-ReportName] - [[-ReportDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing Report -in the specified workspace. -It supports optional parameters for Report description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportName "Updated Report" -ReportDescription "Updated description" -This example updates the Report with ID "Report-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportDescription -An optional new description for the Report. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportId -The unique identifier of the Report to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportName -The new name of the Report. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Report exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricReportDefinition.md b/documentation/Update-FabricReportDefinition.md deleted file mode 100644 index 409736f8..00000000 --- a/documentation/Update-FabricReportDefinition.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricReportDefinition - -## SYNOPSIS -Updates the definition of an existing Report in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricReportDefinition [-WorkspaceId] [-ReportId] [-ReportPathDefinition] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Report -in the specified workspace. -It supports optional parameters for Report definition and platform-specific definition. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportPathDefinition "C:\Path\To\ReportDefinition.json" -This example updates the definition of the Report with ID "Report-67890" in the workspace with ID "workspace-12345" using the provided definition file. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportId -The unique identifier of the Report to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportPathDefinition -A mandatory path to the Report definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Report exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricSemanticModel.md b/documentation/Update-FabricSemanticModel.md deleted file mode 100644 index a3fa9098..00000000 --- a/documentation/Update-FabricSemanticModel.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricSemanticModel - -## SYNOPSIS -Updates an existing SemanticModel in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricSemanticModel [-WorkspaceId] [-SemanticModelId] [-SemanticModelName] - [[-SemanticModelDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing SemanticModel -in the specified workspace. -It supports optional parameters for SemanticModel description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelName "Updated SemanticModel" -SemanticModelDescription "Updated description" -This example updates the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelDescription -An optional new description for the SemanticModel. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelId -The unique identifier of the SemanticModel to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelName -The new name of the SemanticModel. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SemanticModel exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricSemanticModelDefinition.md b/documentation/Update-FabricSemanticModelDefinition.md deleted file mode 100644 index 17d69572..00000000 --- a/documentation/Update-FabricSemanticModelDefinition.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricSemanticModelDefinition - -## SYNOPSIS -Updates the definition of an existing SemanticModel in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricSemanticModelDefinition [-WorkspaceId] [-SemanticModelId] - [-SemanticModelPathDefinition] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SemanticModel -in the specified workspace. -It supports optional parameters for SemanticModel definition and platform-specific definition. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelPathDefinition "C:\Path\To\SemanticModelDefinition.json" -This example updates the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" using the provided definition file. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelId -The unique identifier of the SemanticModel to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SemanticModelPathDefinition -An optional path to the SemanticModel definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SemanticModel exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricSparkCustomPool.md b/documentation/Update-FabricSparkCustomPool.md deleted file mode 100644 index 6d2457bf..00000000 --- a/documentation/Update-FabricSparkCustomPool.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricSparkCustomPool - -## SYNOPSIS -Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricSparkCustomPool [-WorkspaceId] [-SparkCustomPoolId] [-InstancePoolName] - [-NodeFamily] [-NodeSize] [-AutoScaleEnabled] [-AutoScaleMinNodeCount] - [-AutoScaleMaxNodeCount] [-DynamicExecutorAllocationEnabled] - [-DynamicExecutorAllocationMinExecutors] [-DynamicExecutorAllocationMaxExecutors] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool -in the specified workspace. -It supports various parameters for Spark custom pool configuration. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolId "pool-67890" -InstancePoolName "Updated Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 -This example updates the Spark custom pool with ID "pool-67890" in the workspace with ID "workspace-12345" with a new name and configuration. -``` - -## PARAMETERS - -### -AutoScaleEnabled -Specifies whether auto-scaling is enabled for the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoScaleMaxNodeCount -The maximum number of nodes for auto-scaling in the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 8 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoScaleMinNodeCount -The minimum number of nodes for auto-scaling in the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 7 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicExecutorAllocationEnabled -Specifies whether dynamic executor allocation is enabled for the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 9 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicExecutorAllocationMaxExecutors -The maximum number of executors for dynamic executor allocation in the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 11 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicExecutorAllocationMinExecutors -The minimum number of executors for dynamic executor allocation in the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 10 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstancePoolName -The new name of the Spark custom pool. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeFamily -The family of nodes to be used in the Spark custom pool. -This parameter is mandatory and must be 'MemoryOptimized'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeSize -The size of the nodes to be used in the Spark custom pool. -This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkCustomPoolId -The unique identifier of the Spark custom pool to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Spark custom pool exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricSparkJobDefinition.md b/documentation/Update-FabricSparkJobDefinition.md deleted file mode 100644 index d7921077..00000000 --- a/documentation/Update-FabricSparkJobDefinition.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricSparkJobDefinition - -## SYNOPSIS -Updates an existing SparkJobDefinition in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricSparkJobDefinition [-WorkspaceId] [-SparkJobDefinitionId] - [-SparkJobDefinitionName] [[-SparkJobDefinitionDescription] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing SparkJobDefinition -in the specified workspace. -It supports optional parameters for SparkJobDefinition description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionName "Updated SparkJobDefinition" -SparkJobDefinitionDescription "Updated description" -This example updates the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionDescription -An optional new description for the SparkJobDefinition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionId -The unique identifier of the SparkJobDefinition to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionName -The new name of the SparkJobDefinition. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SparkJobDefinition exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricSparkJobDefinitionDefinition.md b/documentation/Update-FabricSparkJobDefinitionDefinition.md deleted file mode 100644 index fb3ab557..00000000 --- a/documentation/Update-FabricSparkJobDefinitionDefinition.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricSparkJobDefinitionDefinition - -## SYNOPSIS -Updates the definition of an existing SparkJobDefinition in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricSparkJobDefinitionDefinition [-WorkspaceId] [-SparkJobDefinitionId] - [-SparkJobDefinitionPathDefinition] [[-SparkJobDefinitionPathPlatformDefinition] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SparkJobDefinition -in the specified workspace. -It supports optional parameters for SparkJobDefinition definition and platform-specific definition. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionPathDefinition "C:\Path\To\SparkJobDefinitionDefinition.json" -This example updates the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" using the provided definition file. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionId -The unique identifier of the SparkJobDefinition to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionPathDefinition -An optional path to the SparkJobDefinition definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkJobDefinitionPathPlatformDefinition -An optional path to the platform-specific definition file to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the SparkJobDefinition exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricSparkSettings.md b/documentation/Update-FabricSparkSettings.md deleted file mode 100644 index 3057b20e..00000000 --- a/documentation/Update-FabricSparkSettings.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricSparkSettings - -## SYNOPSIS -Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricSparkSettings [-WorkspaceId] [[-automaticLogEnabled] ] - [[-notebookInteractiveRunEnabled] ] [[-customizeComputeEnabled] ] - [[-defaultPoolName] ] [[-defaultPoolType] ] [[-starterPoolMaxNode] ] - [[-starterPoolMaxExecutors] ] [[-EnvironmentName] ] [[-EnvironmentRuntimeVersion] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool -in the specified workspace. -It supports various parameters for Spark custom pool configuration. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricSparkSettings -WorkspaceId "workspace-12345" -SparkSettingsId "pool-67890" -InstancePoolName "Updated Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 -This example updates the Spark custom pool with ID "pool-67890" in the workspace with ID "workspace-12345" with a new name and configuration. -``` - -## PARAMETERS - -### -automaticLogEnabled -Specifies whether automatic logging is enabled for the Spark custom pool. -This parameter is optional. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -customizeComputeEnabled -Specifies whether compute customization is enabled for the Spark custom pool. -This parameter is optional. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -defaultPoolName -The name of the default pool for the Spark custom pool. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -defaultPoolType -The type of the default pool for the Spark custom pool. -This parameter is optional and must be either 'Workspace' or 'Capacity'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The name of the environment for the Spark custom pool. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentRuntimeVersion -The runtime version of the environment for the Spark custom pool. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -notebookInteractiveRunEnabled -Specifies whether notebook interactive run is enabled for the Spark custom pool. -This parameter is optional. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -starterPoolMaxExecutors -The maximum number of executors for the starter pool in the Spark custom pool. -This parameter is optional. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -starterPoolMaxNode -The maximum number of nodes for the starter pool in the Spark custom pool. -This parameter is optional. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the Spark custom pool exists. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricWarehouse.md b/documentation/Update-FabricWarehouse.md deleted file mode 100644 index 3330792d..00000000 --- a/documentation/Update-FabricWarehouse.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricWarehouse - -## SYNOPSIS -Updates an existing warehouse in a specified Microsoft Fabric workspace. - -## SYNTAX - -``` -Update-FabricWarehouse [-WorkspaceId] [-WarehouseId] [-WarehouseName] - [[-WarehouseDescription] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This function sends a PATCH request to the Microsoft Fabric API to update an existing warehouse -in the specified workspace. -It supports optional parameters for warehouse description. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" -WarehouseName "Updated Warehouse" -WarehouseDescription "Updated description" -This example updates the warehouse with ID "warehouse-67890" in the workspace with ID "workspace-12345" with a new name and description. -``` - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarehouseDescription -An optional new description for the warehouse. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarehouseId -The unique identifier of the warehouse to be updated. -This parameter is mandatory. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarehouseName -The new name of the warehouse. -This parameter is mandatory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the warehouse exists. -This parameter is optional. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricWorkspace.md b/documentation/Update-FabricWorkspace.md deleted file mode 100644 index 1c840cf9..00000000 --- a/documentation/Update-FabricWorkspace.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricWorkspace - -## SYNOPSIS -Updates the properties of a Fabric workspace. - -## SYNTAX - -``` -Update-FabricWorkspace [-WorkspaceId] [-WorkspaceName] [[-WorkspaceDescription] ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Update-FabricWorkspace\` function updates the name and/or description of a specified Fabric workspace by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricWorkspace -WorkspaceId "workspace123" -WorkspaceName "NewWorkspaceName" -``` - -Updates the name of the workspace with the ID "workspace123" to "NewWorkspaceName". - -### EXAMPLE 2 -``` -Update-FabricWorkspace -WorkspaceId "workspace123" -WorkspaceName "NewName" -WorkspaceDescription "Updated description" -``` - -Updates both the name and description of the workspace "workspace123". - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceDescription -(Optional) The new description for the workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceName -The new name for the workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Update-FabricWorkspaceRoleAssignment.md b/documentation/Update-FabricWorkspaceRoleAssignment.md deleted file mode 100644 index 2dc6cdfb..00000000 --- a/documentation/Update-FabricWorkspaceRoleAssignment.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Update-FabricWorkspaceRoleAssignment - -## SYNOPSIS -Updates the role assignment for a specific principal in a Fabric workspace. - -## SYNTAX - -``` -Update-FabricWorkspaceRoleAssignment [-WorkspaceId] [-WorkspaceRoleAssignmentId] - [-WorkspaceRole] [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The \`Update-FabricWorkspaceRoleAssignment\` function updates the role assigned to a principal in a workspace by making a PATCH request to the API. - -## EXAMPLES - -### EXAMPLE 1 -``` -Update-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "assignment456" -WorkspaceRole "Admin" -``` - -Updates the role assignment to "Admin" for the specified workspace and role assignment. - -## PARAMETERS - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The unique identifier of the workspace where the role assignment exists. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceRole -The new role to assign to the principal. -Must be one of the following: -- Admin -- Contributor -- Member -- Viewer - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceRoleAssignmentId -The unique identifier of the role assignment to be updated. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## 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 diff --git a/documentation/Write-FabricLakehouseTableData.md b/documentation/Write-FabricLakehouseTableData.md deleted file mode 100644 index cf19012e..00000000 --- a/documentation/Write-FabricLakehouseTableData.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: FabricTools-help.xml -Module Name: FabricTools -online version: https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP - -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. - -Author: Tiago Balabuch -schema: 2.0.0 ---- - -# Write-FabricLakehouseTableData - -## SYNOPSIS -Loads data into a specified table in a Lakehouse within a Fabric workspace. - -## SYNTAX - -``` -Write-FabricLakehouseTableData [-WorkspaceId] [-LakehouseId] [-TableName] - [-PathType] [-RelativePath] [-FileFormat] [[-CsvDelimiter] ] - [[-CsvHeader] ] [-Mode] [[-Recursive] ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Loads data into a specified table in a Lakehouse within a Fabric workspace. -The function supports loading data from files or folders, with options for file format and CSV settings. - -## EXAMPLES - -### EXAMPLE 1 -``` -Import-FabricLakehouseTableData -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -TableName "your-table-name" -PathType "File" -RelativePath "path/to/your/file.csv" -FileFormat "CSV" -CsvDelimiter "," -CsvHeader $true -Mode "append" -Recursive $false -This example loads data from a CSV file into the specified table in the Lakehouse. -``` - -### EXAMPLE 2 -``` -Import-FabricLakehouseTableData -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -TableName "your-table-name" -PathType "Folder" -RelativePath "path/to/your/folder" -FileFormat "Parquet" -Mode "overwrite" -Recursive $true -This example loads data from a folder into the specified table in the Lakehouse, overwriting any existing data. -``` - -## PARAMETERS - -### -CsvDelimiter -The delimiter used in the CSV file (default is comma). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: , -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CsvHeader -Indicates whether the CSV file has a header row (default is false). - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileFormat -The format of the file to load data from (CSV or Parquet). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LakehouseId -The ID of the Lakehouse where the table resides. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -The mode for loading data (append or overwrite). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 9 -Default value: Append -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathType -The type of path to load data from (File or Folder). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recursive -Indicates whether to load data recursively from subfolders (default is false). - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RelativePath -The relative path to the file or folder to load data from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TableName -The name of the table to load data into. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -The ID of the workspace containing the Lakehouse. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Author: Tiago Balabuch - -## RELATED LINKS diff --git a/documentation/readme.md b/documentation/readme.md deleted file mode 100644 index 90df9aaa..00000000 --- a/documentation/readme.md +++ /dev/null @@ -1,622 +0,0 @@ ---- -Module Name: FabricTools -Module Guid: f2a0f9e6-fab6-41fc-9e1c-0c94ff38f794 -Download Help Link: {{ Update Download Link }} -Help Version: {{ Please enter version of help manually (X.X.X.X) format }} -Locale: en-US ---- - -# FabricTools Module -## Description -{{ Fill in the Description }} - -## FabricTools Cmdlets -### [Add-FabricDomainWorkspaceAssignmentByCapacity](Add-FabricDomainWorkspaceAssignmentByCapacity.md) -The `Add-FabricDomainWorkspaceAssignmentByCapacity` function assigns workspaces to a Fabric domain using a list of capacity IDs by making a POST request to the relevant API endpoint. - -### [Add-FabricDomainWorkspaceAssignmentById](Add-FabricDomainWorkspaceAssignmentById.md) -The `Add-FabricDomainWorkspaceAssignmentById` function sends a request to assign multiple workspaces to a specified domain using the provided domain ID and an array of workspace IDs. - -### [Add-FabricDomainWorkspaceAssignmentByPrincipal](Add-FabricDomainWorkspaceAssignmentByPrincipal.md) -The `Add-FabricDomainWorkspaceAssignmentByPrincipal` function sends a request to assign workspaces to a specified domain using a JSON object of principal IDs and types. - -### [Add-FabricDomainWorkspaceRoleAssignment](Add-FabricDomainWorkspaceRoleAssignment.md) -The `AssignFabricDomainWorkspaceRoleAssignment` function performs bulk role assignments for principals in a specific Fabric domain. It sends a POST request to the relevant API endpoint. - -### [Add-FabricWorkspaceCapacityAssignment](Add-FabricWorkspaceCapacityAssignment.md) -The `Add-FabricWorkspaceCapacityAssignment` function sends a POST request to assign a workspace to a specific capacity. - -### [Add-FabricWorkspaceIdentity](Add-FabricWorkspaceIdentity.md) -The `Add-FabricWorkspaceIdentity` function provisions an identity for a specified workspace by making an API call. - -### [Add-FabricWorkspaceRoleAssignment](Add-FabricWorkspaceRoleAssignment.md) -The `Add-FabricWorkspaceRoleAssignments` function assigns a role (e.g., Admin, Contributor, Member, Viewer) to a principal (e.g., User, Group, ServicePrincipal) in a Fabric workspace by making a POST request to the API. - -### [Connect-FabricAccount](Connect-FabricAccount.md) -Connects to the Fabric WebAPI by using the cmdlet Connect-AzAccount. This function retrieves the authentication token for the Fabric API and sets up the headers for API calls. - -### [Convert-FromBase64](Convert-FromBase64.md) -The Convert-FromBase64 function takes a Base64-encoded string as input, decodes it into a byte array, and converts it back into a UTF-8 encoded string. It is useful for reversing Base64 encoding applied to text or other data. - -### [Convert-ToBase64](Convert-ToBase64.md) -The Convert-ToBase64 function takes a file path as input, reads the file's content as a byte array, and converts it into a Base64-encoded string. This is useful for embedding binary data (e.g., images, documents) in text-based formats such as JSON or XML. - -### [Export-FabricItem](Export-FabricItem.md) -The Export-FabricItem function exports items from a Fabric workspace to a specified directory. It can export items of type "Report", "SemanticModel", "SparkJobDefinitionV1" or "Notebook". If a specific item ID is provided, only that item will be exported. Otherwise, all items in the workspace will be exported. - -### [Get-FabricAPIClusterURI](Get-FabricAPIClusterURI.md) -The Get-FabricAPIclusterURI function retrieves the cluster URI for the tenant. It supports multiple aliases for flexibility. - -### [Get-FabricAuthToken](Get-FabricAuthToken.md) -The Get-FabricAuthToken function retrieves the Fabric API authentication token. If the token is not already set, the function fails. - -### [Get-FabricCapacities](Get-FabricCapacities.md) -The Get-AllFabricCapacities function is used to retrieve all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided. It uses the Az module to interact with Azure. - -### [Get-FabricCapacity](Get-FabricCapacity.md) -This function retrieves capacity details from a specified workspace using either the provided capacityId or capacityName. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricCapacityRefreshables](Get-FabricCapacityRefreshables.md) -The Get-FabricCapacityRefreshables function retrieves the top refreshable capacities for the tenant. It supports multiple aliases for flexibility. - -### [Get-FabricCapacitySkus](Get-FabricCapacitySkus.md) -This function makes a GET request to the Fabric API to retrieve the tenant settings. - -### [Get-FabricCapacityState](Get-FabricCapacityState.md) -The Get-FabricCapacityState function retrieves the state of a specific capacity. It supports multiple aliases for flexibility. - -### [Get-FabricCapacityTenantOverrides](Get-FabricCapacityTenantOverrides.md) -The Get-FabricCapacityTenantOverrides function retrieves the tenant overrides for all capacities. It supports multiple aliases for flexibility. - -### [Get-FabricCapacityTenantSettingOverrides](Get-FabricCapacityTenantSettingOverrides.md) -The `Get-FabricCapacityTenantSettingOverrides` function retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant by making a GET request to the appropriate API endpoint. If a `capacityId` is provided, the function retrieves overrides for that specific capacity. Otherwise, it retrieves overrides for all capacities. - -### [Get-FabricCapacityWorkload](Get-FabricCapacityWorkload.md) -The Get-FabricCapacityWorkload function retrieves the workloads for a specific capacity. It supports multiple aliases for flexibility. - -### [Get-FabricConfig](Get-FabricConfig.md) -Gets the configuration for use with all functions in the PSFabricTools module. - -### [Get-FabricConnection](Get-FabricConnection.md) -The Get-FabricConnection function retrieves Fabric connections. It can retrieve all connections or the specified one only. - -### [Get-FabricCopyJob](Get-FabricCopyJob.md) -This function retrieves CopyJob details from a specified workspace using either the provided CopyJobId or CopyJob. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricCopyJobDefinition](Get-FabricCopyJobDefinition.md) -This function fetches the Copy Job's content or metadata from a workspace. It supports both synchronous and asynchronous operations, with detailed logging and error handling. - -### [Get-FabricDashboard](Get-FabricDashboard.md) -This function retrieves all dashboards from a specified workspace using the provided WorkspaceId. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricDatamart](Get-FabricDatamart.md) -This function retrieves all datamarts from a specified workspace using the provided WorkspaceId. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricDataPipeline](Get-FabricDataPipeline.md) -This function retrieves all data pipelines from a specified workspace using either the provided Data PipelineId or Data PipelineName. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricDatasetRefreshes](Get-FabricDatasetRefreshes.md) -The Get-FabricDatasetRefreshes function uses the PowerBI cmdlets to retrieve the refresh history of a specified dataset in a workspace. It uses the dataset ID and workspace ID to get the dataset and checks if it is refreshable. If it is, the function retrieves the refresh history. - -### [Get-FabricDebugInfo](Get-FabricDebugInfo.md) -Shows internal debug information about the current session. It is useful for troubleshooting purposes. It will show you the current session object. This includes the bearer token. This can be useful for connecting to the REST API directly via Postman. - -### [Get-FabricDomain](Get-FabricDomain.md) -The `Get-FabricDomain` function allows retrieval of domains in Microsoft Fabric, with optional filtering by domain ID or name. Additionally, it can filter to return only non-empty domains. - -### [Get-FabricDomainTenantSettingOverrides](Get-FabricDomainTenantSettingOverrides.md) -The `Get-FabricDomainTenantSettingOverrides` function retrieves tenant setting overrides for all domains in the Fabric tenant by making a GET request to the designated API endpoint. The function ensures token validity before making the request and handles the response appropriately. - -### [Get-FabricDomainWorkspace](Get-FabricDomainWorkspace.md) -The `Get-FabricDomainWorkspace` function fetches the workspaces for the given domain ID. - -### [Get-FabricEnvironment](Get-FabricEnvironment.md) -The `Get-FabricEnvironment` function sends a GET request to the Fabric API to retrieve environment details for a given workspace. It can filter the results by `EnvironmentName`. - -### [Get-FabricEnvironmentLibrary](Get-FabricEnvironmentLibrary.md) -The Get-FabricEnvironmentLibrary function fetches library information for a given workspace and environment using the Microsoft Fabric API. It ensures the authentication token is valid and validates the response to handle errors gracefully. - -### [Get-FabricEnvironmentSparkCompute](Get-FabricEnvironmentSparkCompute.md) -The Get-FabricEnvironmentSparkCompute function communicates with the Microsoft Fabric API to fetch information about Spark compute resources associated with a specified environment. It ensures that the API token is valid and gracefully handles errors during the API call. - -### [Get-FabricEnvironmentStagingLibrary](Get-FabricEnvironmentStagingLibrary.md) -The Get-FabricEnvironmentStagingLibrary function interacts with the Microsoft Fabric API to fetch information about staging libraries associated with a specified environment. It ensures token validity and handles API errors gracefully. - -### [Get-FabricEnvironmentStagingSparkCompute](Get-FabricEnvironmentStagingSparkCompute.md) -The Get-FabricEnvironmentStagingSparkCompute function interacts with the Microsoft Fabric API to fetch information about staging Spark compute configurations for a specified environment. It ensures token validity and handles API errors gracefully. - -### [Get-FabricEventhouse](Get-FabricEventhouse.md) -Retrieves Fabric Eventhouses. Without the EventhouseName or EventhouseID parameter, all Eventhouses are returned. If you want to retrieve a specific Eventhouse, you can use the EventhouseName or EventhouseID parameter. These parameters cannot be used together. - -### [Get-FabricEventhouseDefinition](Get-FabricEventhouseDefinition.md) -This function retrieves the definition of an Eventhouse from a specified workspace using the provided EventhouseId. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricEventstream](Get-FabricEventstream.md) -Retrieves Fabric Eventstreams. Without the EventstreamName or EventstreamID parameter, all Eventstreams are returned. If you want to retrieve a specific Eventstream, you can use the EventstreamName or EventstreamID parameter. These parameters cannot be used together. - -### [Get-FabricEventstreamDefinition](Get-FabricEventstreamDefinition.md) -This function fetches the Eventstream's content or metadata from a workspace. Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -### [Get-FabricExternalDataShares](Get-FabricExternalDataShares.md) -This function retrieves External Data Shares details. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricItem](Get-FabricItem.md) -The Get-FabricItem function retrieves fabric items from a specified workspace. It can retrieve all items or filter them by item type. - -### [Get-FabricKQLDashboard](Get-FabricKQLDashboard.md) -The `Get-FabricKQLDashboard` function sends a GET request to the Fabric API to retrieve KQLDashboard details for a given workspace. It can filter the results by `KQLDashboardName`. - -### [Get-FabricKQLDashboardDefinition](Get-FabricKQLDashboardDefinition.md) -This function fetches the KQLDashboard's content or metadata from a workspace. Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -### [Get-FabricKQLDatabase](Get-FabricKQLDatabase.md) -The `Get-FabricKQLDatabase` function sends a GET request to the Fabric API to retrieve KQLDatabase details for a given workspace. It can filter the results by `KQLDatabaseName`. - -### [Get-FabricKQLDatabaseDefinition](Get-FabricKQLDatabaseDefinition.md) -This function fetches the KQLDatabase's content or metadata from a workspace. It supports retrieving KQLDatabase definitions in the Jupyter KQLDatabase (`ipynb`) format. Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -### [Get-FabricKQLQueryset](Get-FabricKQLQueryset.md) -The `Get-FabricKQLQueryset` function sends a GET request to the Fabric API to retrieve KQLQueryset details for a given workspace. It can filter the results by `KQLQuerysetName`. - -### [Get-FabricKQLQuerysetDefinition](Get-FabricKQLQuerysetDefinition.md) -This function fetches the KQLQueryset's content or metadata from a workspace. Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -### [Get-FabricLakehouse](Get-FabricLakehouse.md) -The `Get-FabricLakehouse` function sends a GET request to the Fabric API to retrieve Lakehouse details for a given workspace. It can filter the results by `LakehouseName`. - -### [Get-FabricLakehouseTable](Get-FabricLakehouseTable.md) -This function retrieves tables from a specified Lakehouse in a Fabric workspace. It handles pagination using a continuation token to ensure all data is retrieved. - -### [Get-FabricLongRunningOperation](Get-FabricLongRunningOperation.md) -The Get-FabricLongRunningOperation function queries the Microsoft Fabric API to check the status of a long-running operation. It periodically polls the operation until it reaches a terminal state (Succeeded or Failed). - -### [Get-FabricLongRunningOperationResult](Get-FabricLongRunningOperationResult.md) -The Get-FabricLongRunningOperationResult function queries the Microsoft Fabric API to fetch the result of a specific long-running operation. This is typically used after confirming the operation has completed successfully. - -### [Get-FabricMirroredDatabase](Get-FabricMirroredDatabase.md) -The `Get-FabricMirroredDatabase` function sends a GET request to the Fabric API to retrieve MirroredDatabase details for a given workspace. It can filter the results by `MirroredDatabaseName`. - -### [Get-FabricMirroredDatabaseDefinition](Get-FabricMirroredDatabaseDefinition.md) -This function fetches the MirroredDatabase's content or metadata from a workspace. Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -### [Get-FabricMirroredDatabaseStatus](Get-FabricMirroredDatabaseStatus.md) -Retrieves the status of a mirrored database in a specified workspace. The function validates the authentication token, constructs the API endpoint URL, and makes a POST request to retrieve the mirroring status. It handles errors and logs messages at various levels (Debug, Error). - -### [Get-FabricMirroredDatabaseTableStatus](Get-FabricMirroredDatabaseTableStatus.md) -Retrieves the status of tables in a mirrored database. The function validates the authentication token, constructs the API endpoint URL, and makes a POST request to retrieve the mirroring status of tables. It handles errors and logs messages at various levels (Debug, Error). - -### [Get-FabricMirroredWarehouse](Get-FabricMirroredWarehouse.md) -The `Get-FabricMirroredWarehouse` function sends a GET request to the Fabric API to retrieve MirroredWarehouse details for a given workspace. It can filter the results by `MirroredWarehouseName`. - -### [Get-FabricMLExperiment](Get-FabricMLExperiment.md) -This function retrieves ML Experiment details from a specified workspace using either the provided MLExperimentId or MLExperimentName. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricMLModel](Get-FabricMLModel.md) -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. - -### [Get-FabricNotebook](Get-FabricNotebook.md) -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`. - -### [Get-FabricNotebookDefinition](Get-FabricNotebookDefinition.md) -This function fetches the notebook's content or metadata from a workspace. It supports retrieving notebook definitions in the Jupyter Notebook (`ipynb`) format. Handles both synchronous and asynchronous operations, with detailed logging and error handling. - -### [Get-FabricPaginatedReport](Get-FabricPaginatedReport.md) -This function retrieves paginated report details from a specified workspace using either the provided PaginatedReportId or PaginatedReportName. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricRecoveryPoint](Get-FabricRecoveryPoint.md) -Get a list of Fabric recovery points. Results can be filter by date or type. - -### [Get-FabricReflex](Get-FabricReflex.md) -This function retrieves Reflex details from a specified workspace using either the provided ReflexId or ReflexName. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricReflexDefinition](Get-FabricReflexDefinition.md) -This function retrieves the definition of an Reflex from a specified workspace using the provided ReflexId. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricReport](Get-FabricReport.md) -This function retrieves Report details from a specified workspace using either the provided ReportId or ReportName. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricReportDefinition](Get-FabricReportDefinition.md) -This function retrieves the definition of an Report from a specified workspace using the provided ReportId. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricSemanticModel](Get-FabricSemanticModel.md) -This function retrieves SemanticModel details from a specified workspace using either the provided SemanticModelId or SemanticModelName. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricSemanticModelDefinition](Get-FabricSemanticModelDefinition.md) -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. - -### [Get-FabricSparkCustomPool](Get-FabricSparkCustomPool.md) -This function retrieves all Spark custom pools from a specified workspace using the provided WorkspaceId. It handles token validation, constructs the API URL, makes the API request, and processes the response. The function supports filtering by SparkCustomPoolId or SparkCustomPoolName, but not both simultaneously. - -### [Get-FabricSparkJobDefinition](Get-FabricSparkJobDefinition.md) -This function retrieves SparkJobDefinition details from a specified workspace using either the provided SparkJobDefinitionId or SparkJobDefinitionName. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricSparkJobDefinitionDefinition](Get-FabricSparkJobDefinitionDefinition.md) -This function retrieves the definition of an SparkJobDefinition from a specified workspace using the provided SparkJobDefinitionId. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricSparkSettings](Get-FabricSparkSettings.md) -This function retrieves Spark settings from a specified workspace using the provided WorkspaceId. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricSQLDatabase](Get-FabricSQLDatabase.md) -Retrieves Fabric SQL Database details. Without the SQLDatabaseName or SQLDatabaseID parameter, all SQL Databases are returned. If you want to retrieve a specific SQLDatabase, you can use the SQLDatabaseName or SQLDatabaseID parameter. These parameters cannot be used together. - -### [Get-FabricSQLEndpoint](Get-FabricSQLEndpoint.md) -The Get-FabricSQLEndpoint function retrieves SQL Endpoints from a specified workspace in Fabric. It supports filtering by SQL Endpoint ID or SQL Endpoint Name. If both filters are provided, an error message is returned. The function handles token validation, API requests with continuation tokens, and processes the response to return the desired SQL Endpoint(s). - -### [Get-FabricTenantSetting](Get-FabricTenantSetting.md) -The `Get-FabricTenantSetting` function retrieves tenant settings for a Fabric environment by making a GET request to the appropriate API endpoint. Optionally, it filters the results by the `SettingTitle` parameter. - -### [Get-FabricUsageMetricsQuery](Get-FabricUsageMetricsQuery.md) -The Get-FabricUsageMetricsQuery function retrieves usage metrics for a specific dataset. It supports multiple aliases for flexibility. - -### [Get-FabricUserListAccessEntities](Get-FabricUserListAccessEntities.md) -This function retrieves a list of access entities associated with a specified user in Microsoft Fabric. It supports filtering by entity type and handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricWarehouse](Get-FabricWarehouse.md) -This function retrieves warehouse details from a specified workspace using either the provided WarehouseId or WarehouseName. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Get-FabricWorkspace](Get-FabricWorkspace.md) -The `Get-FabricWorkspace` function fetches workspace details from the Fabric API. It supports filtering by WorkspaceId or WorkspaceName. - -### [Get-FabricWorkspaceDatasetRefreshes](Get-FabricWorkspaceDatasetRefreshes.md) -The Get-FabricWorkspaceDatasetRefreshes function uses the PowerBI cmdlets to retrieve the refresh history of all datasets in a specified workspace. It uses the workspace ID to get the workspace and its datasets, and then retrieves the refresh history for each dataset. - -### [Get-FabricWorkspaceRoleAssignment](Get-FabricWorkspaceRoleAssignment.md) -The `Get-FabricWorkspaceRoleAssignments` function fetches the role assignments associated with a Fabric workspace by making a GET request to the API. If `WorkspaceRoleAssignmentId` is provided, it retrieves the specific role assignment. - -### [Get-FabricWorkspaceTenantSettingOverrides](Get-FabricWorkspaceTenantSettingOverrides.md) -The `Get-FabricWorkspaceTenantSettingOverrides` function retrieves tenant setting overrides for all workspaces in the Fabric tenant by making a GET request to the appropriate API endpoint. The function validates the authentication token before making the request and handles the response accordingly. - -### [Get-FabricWorkspaceUsageMetricsData](Get-FabricWorkspaceUsageMetricsData.md) -The Get-FabricWorkspaceUsageMetricsData function retrieves workspace usage metrics. It supports multiple aliases for flexibility. - -### [Get-FabricWorkspaceUser](Get-FabricWorkspaceUser.md) -The Get-FabricWorkspaceUser function retrieves the details of the users of a workspace. - -### [Get-SHA256](Get-SHA256.md) -The Get-Sha256 function calculates the SHA256 hash of a string. - -### [Import-FabricEnvironmentStagingLibrary](Import-FabricEnvironmentStagingLibrary.md) -This function sends a POST request to the Microsoft Fabric API to upload a library to the specified environment staging area for the given workspace. - -### [Import-FabricItem](Import-FabricItem.md) -The Import-FabricItem function imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. It supports multiple aliases for flexibility. The function handles the import of datasets and reports, ensuring that the correct item type is used and that the items are created or updated as necessary. - -### [Invoke-FabricAPIRequest_duplicate](Invoke-FabricAPIRequest_duplicate.md) -The Invoke-RestMethod function is used to send an HTTP request to a Fabric API endpoint and retrieve the response. It handles various aspects such as authentication, 429 throttling, and Long-Running-Operation (LRO) response. - -### [Invoke-FabricDatasetRefresh](Invoke-FabricDatasetRefresh.md) -The Invoke-FabricDatasetRefresh function is used to refresh a PowerBI dataset. It first checks if the dataset is refreshable. If it is not, it writes an error. If it is, it invokes a PowerBI REST method to refresh the dataset. The URL for the request is constructed using the provided dataset ID. - -### [Invoke-FabricKQLCommand](Invoke-FabricKQLCommand.md) -Executes a KQL command in a Kusto Database. The KQL command is executed in the Kusto Database that is specified by the KQLDatabaseName or KQLDatabaseId parameter. The KQL command is executed in the context of the Fabric Real-Time Intelligence session that is established by the Connect-RTISession cmdlet. The cmdlet distinguishes between management commands and query commands. Management commands are executed in the management API, while query commands are executed in the query API. The distinction is made by checking if the KQL command starts with a dot. If it does, it is a management command else it is a query command. If the KQL command is a management command, it is crucial to have the execute database script <| in the beginning, otherwise the Kusto API will not execute the script. This cmdlet will automatically add the .execute database script <| in the beginning of the KQL command if it is a management command and if it is not already present. If the KQL Command is a query command, the result is returned as an array of PowerShell objects by default. If the parameter -ReturnRawResult is used, the raw result of the KQL query is returned which is a JSON object. - -### [Invoke-FabricRestMethod](Invoke-FabricRestMethod.md) -The Invoke-FabricRestMethod function is used to send an HTTP request to a Fabric API endpoint and retrieve the response. - -### [Invoke-FabricRestMethodExtended](Invoke-FabricRestMethodExtended.md) -The Invoke-FabricRestMethodExtended function is used to send an HTTP request to a Fabric API endpoint and retrieve the response. It handles various aspects such as authentication, 429 throttling, and Long-Running-Operation (LRO) response. - -### [New-FabricCopyJob](New-FabricCopyJob.md) -Sends a POST request to the Microsoft Fabric API to create a new copy job in the specified workspace. Supports optional parameters for description and definition files. - -### [New-FabricDataPipeline](New-FabricDataPipeline.md) -This function sends a POST request to the Microsoft Fabric API to create a new DataPipeline in the specified workspace. It supports optional parameters for DataPipeline description and path definitions for the DataPipeline content. - -### [New-FabricDomain](New-FabricDomain.md) -The `Add-FabricDomain` function creates a new domain in Microsoft Fabric by making a POST request to the relevant API endpoint. - -### [New-FabricEnvironment](New-FabricEnvironment.md) -The `Add-FabricEnvironment` function creates a new environment within a given workspace by making a POST request to the Fabric API. The environment can optionally include a description. - -### [New-FabricEventhouse](New-FabricEventhouse.md) -This function sends a POST request to the Microsoft Fabric API to create a new Eventhouse in the specified workspace. It supports optional parameters for Eventhouse description and path definitions. - -### [New-FabricEventstream](New-FabricEventstream.md) -This function sends a POST request to the Microsoft Fabric API to create a new Eventstream in the specified workspace. It supports optional parameters for Eventstream description and path definitions for the Eventstream content. - -### [New-FabricKQLDashboard](New-FabricKQLDashboard.md) -This function sends a POST request to the Microsoft Fabric API to create a new KQLDashboard in the specified workspace. It supports optional parameters for KQLDashboard description and path definitions for the KQLDashboard content. - -### [New-FabricKQLDatabase](New-FabricKQLDatabase.md) -This function sends a POST request to the Microsoft Fabric API to create a new KQLDatabase in the specified workspace. It supports optional parameters for KQLDatabase description and path definitions for the KQLDatabase content. - -### [New-FabricKQLQueryset](New-FabricKQLQueryset.md) -This function sends a POST request to the Microsoft Fabric API to create a new KQLQueryset in the specified workspace. It supports optional parameters for KQLQueryset description and path definitions for the KQLQueryset content. - -### [New-FabricLakehouse](New-FabricLakehouse.md) -This function sends a POST request to the Microsoft Fabric API to create a new Lakehouse in the specified workspace. It supports optional parameters for Lakehouse description and path definitions for the Lakehouse content. - -### [New-FabricMirroredDatabase](New-FabricMirroredDatabase.md) -This function sends a POST request to the Microsoft Fabric API to create a new MirroredDatabase in the specified workspace. It supports optional parameters for MirroredDatabase description and path definitions for the MirroredDatabase content. - -### [New-FabricMLExperiment](New-FabricMLExperiment.md) -This function sends a POST request to the Microsoft Fabric API to create a new ML Experiment in the specified workspace. It supports optional parameters for ML Experiment description. - -### [New-FabricMLModel](New-FabricMLModel.md) -This function sends a POST request to the Microsoft Fabric API to create a new ML Model in the specified workspace. It supports optional parameters for ML Model description. - -### [New-FabricNotebook](New-FabricNotebook.md) -This function sends a POST request to the Microsoft Fabric API to create a new notebook in the specified workspace. It supports optional parameters for notebook description and path definitions for the notebook content. - -### [New-FabricNotebookNEW](New-FabricNotebookNEW.md) -This function sends a POST request to the Microsoft Fabric API to create a new notebook in the specified workspace. It supports optional parameters for notebook description and path definitions for the notebook content. - -### [New-FabricRecoveryPoint](New-FabricRecoveryPoint.md) -Create a recovery point for a Fabric data warehouse - -### [New-FabricReflex](New-FabricReflex.md) -This function sends a POST request to the Microsoft Fabric API to create a new Reflex in the specified workspace. It supports optional parameters for Reflex description and path definitions. - -### [New-FabricReport](New-FabricReport.md) -This function sends a POST request to the Microsoft Fabric API to create a new Report in the specified workspace. It supports optional parameters for Report description and path definitions. - -### [New-FabricSemanticModel](New-FabricSemanticModel.md) -This function sends a POST request to the Microsoft Fabric API to create a new SemanticModel in the specified workspace. It supports optional parameters for SemanticModel description and path definitions. - -### [New-FabricSparkCustomPool](New-FabricSparkCustomPool.md) -This function sends a POST request to the Microsoft Fabric API to create a new Spark custom pool in the specified workspace. It supports various parameters for Spark custom pool configuration. - -### [New-FabricSparkJobDefinition](New-FabricSparkJobDefinition.md) -This function sends a POST request to the Microsoft Fabric API to create a new SparkJobDefinition in the specified workspace. It supports optional parameters for SparkJobDefinition description and path definitions. - -### [New-FabricSQLDatabase](New-FabricSQLDatabase.md) -This function sends a POST request to the Microsoft Fabric API to create a new SQL Database in the specified workspace. It supports optional parameters for SQL Database description and path definitions for the SQL Database content. - -### [New-FabricWarehouse](New-FabricWarehouse.md) -This function sends a POST request to the Microsoft Fabric API to create a new warehouse in the specified workspace. It supports optional parameters for warehouse description. - -### [New-FabricWorkspace](New-FabricWorkspace.md) -The `Add-FabricWorkspace` function creates a new workspace in the Fabric platform by sending a POST request to the API. It validates the display name and handles both success and error responses. - -### [New-FabricWorkspaceUsageMetricsReport](New-FabricWorkspaceUsageMetricsReport.md) -The New-FabricWorkspaceUsageMetricsReport function retrieves the workspace usage metrics dataset ID. It supports multiple aliases for flexibility. - -### [Publish-FabricEnvironment](Publish-FabricEnvironment.md) -This function interacts with the Microsoft Fabric API to initiate the publishing process for a staging environment. It validates the authentication token, constructs the API request, and handles both immediate and long-running operations. - -### [Register-FabricWorkspaceToCapacity](Register-FabricWorkspaceToCapacity.md) -The Register-FabricWorkspaceToCapacity function Sets a PowerBI workspace to a capacity. It supports multiple aliases for flexibility. - -### [Remove-FabricCopyJob](Remove-FabricCopyJob.md) -This function performs a DELETE operation on the Microsoft Fabric API to remove a Copy Job from the specified workspace using the provided WorkspaceId and CopyJobId parameters. - -### [Remove-FabricDataPipeline](Remove-FabricDataPipeline.md) -This function sends a DELETE request to the Microsoft Fabric API to remove a DataPipeline from the specified workspace using the provided WorkspaceId and DataPipelineId. - -### [Remove-FabricDomain](Remove-FabricDomain.md) -The `Remove-FabricDomain` function removes a specified domain from Microsoft Fabric by making a DELETE request to the relevant API endpoint. - -### [Remove-FabricDomainWorkspaceAssignment](Remove-FabricDomainWorkspaceAssignment.md) -The `Unassign -FabricDomainWorkspace` function allows you to Unassign specific workspaces from a given Fabric domain or unassign all workspaces if no workspace IDs are specified. It makes a POST request to the relevant API endpoint for this operation. - -### [Remove-FabricDomainWorkspaceRoleAssignment](Remove-FabricDomainWorkspaceRoleAssignment.md) -The `AssignFabricDomainWorkspaceRoleAssignment` function performs bulk role assignments for principals in a specific Fabric domain. It sends a POST request to the relevant API endpoint. - -### [Remove-FabricEnvironment](Remove-FabricEnvironment.md) -The `Remove-FabricEnvironment` function sends a DELETE request to the Fabric API to remove a specified environment from a given workspace. - -### [Remove-FabricEnvironmentStagingLibrary](Remove-FabricEnvironmentStagingLibrary.md) -This function allows for the deletion of a library from the staging environment, one file at a time. It ensures token validity, constructs the appropriate API request, and handles both success and failure responses. - -### [Remove-FabricEventhouse](Remove-FabricEventhouse.md) -This function sends a DELETE request to the Microsoft Fabric API to remove an Eventhouse from the specified workspace using the provided WorkspaceId and EventhouseId. - -### [Remove-FabricEventstream](Remove-FabricEventstream.md) -The `Remove-FabricEventstream` function sends a DELETE request to the Fabric API to remove a specified Eventstream from a given workspace. - -### [Remove-FabricItem](Remove-FabricItem.md) -The Remove-FabricItems function removes selected items from a specified Fabric workspace. It uses the workspace ID and an optional filter to select the items to remove. If a filter is provided, only items whose DisplayName matches the filter are removed. - -### [Remove-FabricKQLDashboard](Remove-FabricKQLDashboard.md) -The `Remove-FabricKQLDashboard` function sends a DELETE request to the Fabric API to remove a specified KQLDashboard from a given workspace. - -### [Remove-FabricKQLDatabase](Remove-FabricKQLDatabase.md) -The `Remove-FabricKQLDatabase` function sends a DELETE request to the Fabric API to remove a specified KQLDatabase from a given workspace. - -### [Remove-FabricKQLQueryset](Remove-FabricKQLQueryset.md) -The `Remove-FabricKQLQueryset` function sends a DELETE request to the Fabric API to remove a specified KQLQueryset from a given workspace. - -### [Remove-FabricLakehouse](Remove-FabricLakehouse.md) -The `Remove-FabricLakehouse` function sends a DELETE request to the Fabric API to remove a specified Lakehouse from a given workspace. - -### [Remove-FabricMirroredDatabase](Remove-FabricMirroredDatabase.md) -The `Remove-FabricMirroredDatabase` function sends a DELETE request to the Fabric API to remove a specified MirroredDatabase from a given workspace. - -### [Remove-FabricMLExperiment](Remove-FabricMLExperiment.md) -This function sends a DELETE request to the Microsoft Fabric API to remove an ML Experiment from the specified workspace using the provided WorkspaceId and MLExperimentId. - -### [Remove-FabricMLModel](Remove-FabricMLModel.md) -This function sends a DELETE request to the Microsoft Fabric API to remove an ML Model from the specified workspace using the provided WorkspaceId and MLModelId. - -### [Remove-FabricNotebook](Remove-FabricNotebook.md) -The `Remove-FabricNotebook` function sends a DELETE request to the Fabric API to remove a specified Notebook from a given workspace. - -### [Remove-FabricRecoveryPoint](Remove-FabricRecoveryPoint.md) -Remove a selected Fabric Recovery Point. - -### [Remove-FabricReflex](Remove-FabricReflex.md) -This function sends a DELETE request to the Microsoft Fabric API to remove an Reflex from the specified workspace using the provided WorkspaceId and ReflexId. - -### [Remove-FabricReport](Remove-FabricReport.md) -This function sends a DELETE request to the Microsoft Fabric API to remove an Report from the specified workspace using the provided WorkspaceId and ReportId. - -### [Remove-FabricSemanticModel](Remove-FabricSemanticModel.md) -This function sends a DELETE request to the Microsoft Fabric API to remove an SemanticModel from the specified workspace using the provided WorkspaceId and SemanticModelId. - -### [Remove-FabricSparkCustomPool](Remove-FabricSparkCustomPool.md) -This function sends a DELETE request to the Microsoft Fabric API to remove a Spark custom pool from the specified workspace using the provided WorkspaceId and SparkCustomPoolId. - -### [Remove-FabricSparkJobDefinition](Remove-FabricSparkJobDefinition.md) -This function sends a DELETE request to the Microsoft Fabric API to remove an SparkJobDefinition from the specified workspace using the provided WorkspaceId and SparkJobDefinitionId. - -### [Remove-FabricSQLDatabase](Remove-FabricSQLDatabase.md) -The `Remove-FabricSQLDatabase` function sends a DELETE request to the Fabric API to remove a specified SQLDatabase from a given workspace. - -### [Remove-FabricWarehouse](Remove-FabricWarehouse.md) -This function sends a DELETE request to the Microsoft Fabric API to remove a warehouse from the specified workspace using the provided WorkspaceId and WarehouseId. - -### [Remove-FabricWorkspace](Remove-FabricWorkspace.md) -The `Remove-FabricWorkspace` function deletes a workspace in the Fabric platform by sending a DELETE request to the API. It validates the workspace ID and handles both success and error responses. - -### [Remove-FabricWorkspaceCapacityAssignment](Remove-FabricWorkspaceCapacityAssignment.md) -The `Remove-FabricWorkspaceCapacityAssignment` function sends a POST request to unassign a workspace from its assigned capacity. - -### [Remove-FabricWorkspaceIdentity](Remove-FabricWorkspaceIdentity.md) -The `Remove-FabricWorkspaceCapacity` function deprovisions the Managed Identity from the given workspace by calling the appropriate API endpoint. - -### [Remove-FabricWorkspaceRoleAssignment](Remove-FabricWorkspaceRoleAssignment.md) -The `Remove-FabricWorkspaceRoleAssignment` function deletes a specific role assignment from a Fabric workspace by making a DELETE request to the API. - -### [Restore-FabricRecoveryPoint](Restore-FabricRecoveryPoint.md) -Restore a Fabric data warehouse to a specified restore pont. - -### [Resume-FabricCapacity](Resume-FabricCapacity.md) -The Resume-FabricCapacity function resumes a capacity. It supports multiple aliases for flexibility. - -### [Revoke-FabricCapacityTenantSettingOverrides](Revoke-FabricCapacityTenantSettingOverrides.md) -The `Revoke-FabricCapacityTenantSettingOverrides` function deletes a specific tenant setting override for a given capacity in the Fabric tenant by making a DELETE request to the appropriate API endpoint. - -### [Revoke-FabricExternalDataShares](Revoke-FabricExternalDataShares.md) -This function retrieves External Data Shares details. It handles token validation, constructs the API URL, makes the API request, and processes the response. - -### [Set-FabricConfig](Set-FabricConfig.md) -Register the configuration for use with all functions in the PSFabricTools module. - -### [Start-FabricLakehouseTableMaintenance](Start-FabricLakehouseTableMaintenance.md) -This function sends a POST request to the Fabric API to start a table maintenance job for a specified Lakehouse. It allows for optional parameters such as schema name, table name, and Z-ordering columns. The function also handles asynchronous operations and can wait for completion if specified. - -### [Start-FabricMirroredDatabaseMirroring](Start-FabricMirroredDatabaseMirroring.md) -This function sends a POST request to the Microsoft Fabric API to start the mirroring of a specified mirrored database. It requires the workspace ID and the mirrored database ID as parameters. - -### [Start-FabricSparkJobDefinitionOnDemand](Start-FabricSparkJobDefinitionOnDemand.md) -This function initiates a Spark Job Definition on demand within a specified workspace. It constructs the appropriate API endpoint URL and makes a POST request to start the job. The function can optionally wait for the job to complete based on the 'waitForCompletion' parameter. - -### [Stop-FabricEnvironmentPublish](Stop-FabricEnvironmentPublish.md) -This function sends a cancel publish request to the Microsoft Fabric API for a given environment. It ensures that the token is valid before making the request and handles both successful and error responses. - -### [Stop-FabricMirroredDatabaseMirroring](Stop-FabricMirroredDatabaseMirroring.md) -This function sends a POST request to the Microsoft Fabric API to stop the mirroring of a specified mirrored database. It requires the workspace ID and the mirrored database ID as parameters. - -### [Suspend-FabricCapacity](Suspend-FabricCapacity.md) -The Suspend-FabricCapacity function suspends a capacity. It supports multiple aliases for flexibility. - -### [Unregister-FabricWorkspaceToCapacity](Unregister-FabricWorkspaceToCapacity.md) -The Unregister-FabricWorkspaceToCapacity function unregisters a workspace from a capacity in PowerBI. It can be used to remove a workspace from a capacity, allowing it to be assigned to a different capacity or remain unassigned. - -### [Update-FabricCapacityTenantSettingOverrides](Update-FabricCapacityTenantSettingOverrides.md) -The `Update-FabricCapacityTenantSettingOverrides` function updates tenant setting overrides in a Fabric environment by making a POST request to the appropriate API endpoint. It allows specifying settings such as enabling tenant settings, delegating to a workspace, and including or excluding security groups. - -### [Update-FabricCopyJob](Update-FabricCopyJob.md) -Sends a PATCH request to the Microsoft Fabric API to update an existing Copy Job in the specified workspace. Allows updating the Copy Job's name and optionally its description. - -### [Update-FabricCopyJobDefinition](Update-FabricCopyJobDefinition.md) -This function updates the content or metadata of a Copy Job within a Microsoft Fabric workspace. The Copy Job content and platform-specific definitions can be provided as file paths, which will be encoded as Base64 and sent in the request. - -### [Update-FabricDataPipeline](Update-FabricDataPipeline.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing DataPipeline in the specified workspace. It supports optional parameters for DataPipeline description. - -### [Update-FabricDomain](Update-FabricDomain.md) -The `Update-FabricDomain` function modifies a specified domain in Microsoft Fabric using the provided parameters. - -### [Update-FabricEnvironment](Update-FabricEnvironment.md) -The `Update-FabricEnvironment` function updates the name and/or description of a specified Fabric Environment by making a PATCH request to the API. - -### [Update-FabricEnvironmentStagingSparkCompute](Update-FabricEnvironmentStagingSparkCompute.md) -This function sends a PATCH request to the Microsoft Fabric API to update the Spark compute settings for a specified environment, including instance pool, driver and executor configurations, and dynamic allocation settings. - -### [Update-FabricEventhouse](Update-FabricEventhouse.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing Eventhouse in the specified workspace. It supports optional parameters for Eventhouse description. - -### [Update-FabricEventhouseDefinition](Update-FabricEventhouseDefinition.md) -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Eventhouse in the specified workspace. It supports optional parameters for Eventhouse definition and platform-specific definition. - -### [Update-FabricEventstream](Update-FabricEventstream.md) -The `Update-FabricEventstream` function updates the name and/or description of a specified Fabric Eventstream by making a PATCH request to the API. - -### [Update-FabricEventstreamDefinition](Update-FabricEventstreamDefinition.md) -This function allows updating the content or metadata of a Eventstream in a Microsoft Fabric workspace. The Eventstream content can be provided as file paths, and metadata updates can optionally be enabled. - -### [Update-FabricKQLDashboard](Update-FabricKQLDashboard.md) -The `Update-FabricKQLDashboard` function updates the name and/or description of a specified Fabric KQLDashboard by making a PATCH request to the API. - -### [Update-FabricKQLDashboardDefinition](Update-FabricKQLDashboardDefinition.md) -This function allows updating the content or metadata of a KQLDashboard in a Microsoft Fabric workspace. The KQLDashboard content can be provided as file paths, and metadata updates can optionally be enabled. - -### [Update-FabricKQLDatabase](Update-FabricKQLDatabase.md) -The `Update-FabricKQLDatabase` function updates the name and/or description of a specified Fabric KQLDatabase by making a PATCH request to the API. - -### [Update-FabricKQLDatabaseDefinition](Update-FabricKQLDatabaseDefinition.md) -This function allows updating the content or metadata of a KQLDatabase in a Microsoft Fabric workspace. The KQLDatabase content can be provided as file paths, and metadata updates can optionally be enabled. - -### [Update-FabricKQLQueryset](Update-FabricKQLQueryset.md) -The `Update-FabricKQLQueryset` function updates the name and/or description of a specified Fabric KQLQueryset by making a PATCH request to the API. - -### [Update-FabricKQLQuerysetDefinition](Update-FabricKQLQuerysetDefinition.md) -This function allows updating the content or metadata of a KQLQueryset in a Microsoft Fabric workspace. The KQLQueryset content can be provided as file paths, and metadata updates can optionally be enabled. - -### [Update-FabricLakehouse](Update-FabricLakehouse.md) -The `Update-FabricLakehouse` function updates the name and/or description of a specified Fabric Lakehouse by making a PATCH request to the API. - -### [Update-FabricMirroredDatabase](Update-FabricMirroredDatabase.md) -The `Update-FabricMirroredDatabase` function updates the name and/or description of a specified Fabric MirroredDatabase by making a PATCH request to the API. - -### [Update-FabricMirroredDatabaseDefinition](Update-FabricMirroredDatabaseDefinition.md) -This function allows updating the content or metadata of a MirroredDatabase in a Microsoft Fabric workspace. The MirroredDatabase content can be provided as file paths, and metadata updates can optionally be enabled. - -### [Update-FabricMLExperiment](Update-FabricMLExperiment.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing ML Experiment in the specified workspace. It supports optional parameters for ML Experiment description. - -### [Update-FabricMLModel](Update-FabricMLModel.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing ML Model in the specified workspace. It supports optional parameters for ML Model description. - -### [Update-FabricNotebook](Update-FabricNotebook.md) -The `Update-FabricNotebook` function updates the name and/or description of a specified Fabric Notebook by making a PATCH request to the API. - -### [Update-FabricNotebookDefinition](Update-FabricNotebookDefinition.md) -This function allows updating the content or metadata of a notebook in a Microsoft Fabric workspace. The notebook content can be provided as file paths, and metadata updates can optionally be enabled. - -### [Update-FabricPaginatedReport](Update-FabricPaginatedReport.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing paginated report in the specified workspace. It supports optional parameters for paginated report description. - -### [Update-FabricReflex](Update-FabricReflex.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing Reflex in the specified workspace. It supports optional parameters for Reflex description. - -### [Update-FabricReflexDefinition](Update-FabricReflexDefinition.md) -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Reflex in the specified workspace. It supports optional parameters for Reflex definition and platform-specific definition. - -### [Update-FabricReport](Update-FabricReport.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing Report in the specified workspace. It supports optional parameters for Report description. - -### [Update-FabricReportDefinition](Update-FabricReportDefinition.md) -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Report in the specified workspace. It supports optional parameters for Report definition and platform-specific definition. - -### [Update-FabricSemanticModel](Update-FabricSemanticModel.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing SemanticModel in the specified workspace. It supports optional parameters for SemanticModel description. - -### [Update-FabricSemanticModelDefinition](Update-FabricSemanticModelDefinition.md) -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SemanticModel in the specified workspace. It supports optional parameters for SemanticModel definition and platform-specific definition. - -### [Update-FabricSparkCustomPool](Update-FabricSparkCustomPool.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool in the specified workspace. It supports various parameters for Spark custom pool configuration. - -### [Update-FabricSparkJobDefinition](Update-FabricSparkJobDefinition.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing SparkJobDefinition in the specified workspace. It supports optional parameters for SparkJobDefinition description. - -### [Update-FabricSparkJobDefinitionDefinition](Update-FabricSparkJobDefinitionDefinition.md) -This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SparkJobDefinition in the specified workspace. It supports optional parameters for SparkJobDefinition definition and platform-specific definition. - -### [Update-FabricSparkSettings](Update-FabricSparkSettings.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool in the specified workspace. It supports various parameters for Spark custom pool configuration. - -### [Update-FabricWarehouse](Update-FabricWarehouse.md) -This function sends a PATCH request to the Microsoft Fabric API to update an existing warehouse in the specified workspace. It supports optional parameters for warehouse description. - -### [Update-FabricWorkspace](Update-FabricWorkspace.md) -The `Update-FabricWorkspace` function updates the name and/or description of a specified Fabric workspace by making a PATCH request to the API. - -### [Update-FabricWorkspaceRoleAssignment](Update-FabricWorkspaceRoleAssignment.md) -The `Update-FabricWorkspaceRoleAssignment` function updates the role assigned to a principal in a workspace by making a PATCH request to the API. - -### [Write-FabricLakehouseTableData](Write-FabricLakehouseTableData.md) -Loads data into a specified table in a Lakehouse within a Fabric workspace. The function supports loading data from files or folders, with options for file format and CSV settings. - diff --git a/helper/CreateDocumentation.ps1 b/helper/CreateDocumentation.ps1 deleted file mode 100644 index 2c53a184..00000000 --- a/helper/CreateDocumentation.ps1 +++ /dev/null @@ -1,15 +0,0 @@ -Import-Module -Name platyPS - -$mdHelpParams = @{ - Module = 'FabricTools' - OutputFolder = ".\documentation" - AlphabeticParamsOrder = $true - UseFullTypeName = $true - WithModulePage = $true - ExcludeDontShow = $false - Encoding = [System.Text.Encoding]::UTF8 - ModulePagePath = ".\documentation\readme.md" -} -New-MarkdownHelp @mdHelpParams -Force - -. .\helper\Update-ReadmeDescriptions.ps1 diff --git a/helper/Test-DescriptionExtraction.ps1 b/helper/Test-DescriptionExtraction.ps1 deleted file mode 100644 index 0076856b..00000000 --- a/helper/Test-DescriptionExtraction.ps1 +++ /dev/null @@ -1,59 +0,0 @@ -# Test script to verify description extraction - -function Get-FunctionDescription { - param( - [string]$FilePath - ) - - try { - $content = Get-Content -Path $FilePath -Raw -ErrorAction Stop - - # Pattern to match .DESCRIPTION section in comment-based help - # Find everything between .DESCRIPTION and the next help section (.EXAMPLE, .PARAMETER, .INPUTS, etc.) - $descriptionPattern = '\.DESCRIPTION\s*\r?\n(.*?)(?=\r?\n\.[A-Z]|\r?\n\s*function|\r?\n\s*param|\r?\n\s*\[CmdletBinding|\r?\n\s*$|\r?\n\s*#>)' - - if ($content -match $descriptionPattern) { - $description = $matches[1].Trim() - - # Clean up the description - remove leading/trailing whitespace and normalize line breaks - $description = $description -replace '\r?\n\s*', ' ' - $description = $description -replace '\s+', ' ' - $description = $description.Trim() - - return $description - } - - return $null - } - catch { - Write-Warning "Could not read file: $FilePath - $($_.Exception.Message)" - return $null - } -} - -# Test with Connect-FabricAccount.ps1 -Write-Host "Testing Connect-FabricAccount.ps1..." -ForegroundColor Yellow -$description1 = Get-FunctionDescription -FilePath "source/Public/Connect-FabricAccount.ps1" -if ($description1) { - Write-Host "✓ Found description: $description1" -ForegroundColor Green -} else { - Write-Host "✗ No description found" -ForegroundColor Red -} - -# Test with Get-FabricAuthToken.ps1 -Write-Host "`nTesting Get-FabricAuthToken.ps1..." -ForegroundColor Yellow -$description2 = Get-FunctionDescription -FilePath "source/Public/Get-FabricAuthToken.ps1" -if ($description2) { - Write-Host "✓ Found description: $description2" -ForegroundColor Green -} else { - Write-Host "✗ No description found" -ForegroundColor Red -} - -# Test with a function from subdirectory -Write-Host "`nTesting Get-FabricCapacities.ps1..." -ForegroundColor Yellow -$description3 = Get-FunctionDescription -FilePath "source/Public/Capacity/Get-FabricCapacities.ps1" -if ($description3) { - Write-Host "✓ Found description: $description3" -ForegroundColor Green -} else { - Write-Host "✗ No description found" -ForegroundColor Red -} diff --git a/source/FabricTools.psd1 b/source/FabricTools.psd1 index deafe24d..18c0ce6b 100644 --- a/source/FabricTools.psd1 +++ b/source/FabricTools.psd1 @@ -31,7 +31,7 @@ Copyright = 'Copyright (c) 2025 by FabricTools Team' # Description of the functionality provided by this module Description = 'A module to be able to do more with Microsoft Fabric. It lets you pause and resume Fabric capacities. - Adds functionallity previously only available with the REST API as PowerShell functions. + Adds functionality previously only available with the REST API as PowerShell functions. There are also functions to make it easier to monitor usage metrics and refreshes. It also adds Fabric-friendly aliases for PowerBI functions to make it easier to use the module.' diff --git a/source/Private/Get-FabricContinuationToken.ps1 b/source/Private/Get-FabricContinuationToken.ps1 index 2676934d..14097663 100644 --- a/source/Private/Get-FabricContinuationToken.ps1 +++ b/source/Private/Get-FabricContinuationToken.ps1 @@ -1,4 +1,5 @@ -<# +function Get-FabricContinuationToken { + <# .SYNOPSIS Internal function to handle continuation token logic for Fabric API calls. @@ -19,8 +20,6 @@ This is an internal function used by other functions in the module. Author: Kamil Nowinski #> - -function Get-FabricContinuationToken { [CmdletBinding()] param ( [Parameter(Mandatory = $false)] diff --git a/source/Public/Capacity/Get-FabricCapacities.ps1 b/source/Public/Capacity/Get-FabricCapacities.ps1 index dbfb9b65..e3cd607a 100644 --- a/source/Public/Capacity/Get-FabricCapacities.ps1 +++ b/source/Public/Capacity/Get-FabricCapacities.ps1 @@ -1,29 +1,33 @@ -<# +function Get-FabricCapacities { + <# .SYNOPSIS This function retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided. .DESCRIPTION - The Get-AllFabricCapacities function is used to retrieve all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided. It uses the Az module to interact with Azure. + The Get-FabricCapacities function is used to retrieve all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided. It uses the Az module to interact with Azure. .PARAMETER subscriptionID An optional parameter that specifies the subscription ID. If this parameter is not provided, the function will retrieve resources from all subscriptions. .EXAMPLE - Get-AllFabricCapacities -subscriptionID "12345678-1234-1234-1234-123456789012" + This command retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in the subscription with the ID "12345678-1234-1234-1234-123456789012". ```powershell ``` - This command retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in the subscription with the ID "12345678-1234-1234-1234-123456789012". + ```powershell + Get-FabricCapacities -subscriptionID "12345678-1234-1234-1234-123456789012" + ``` .EXAMPLE - Get-AllFabricCapacities + This command retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in all subscriptions. ```powershell ``` - This command retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in all subscriptions. + ```powershell + Get-FabricCapacities + ``` .NOTES Author: Ioana Bouariu Imported into FabricTools April 2025 Alias: Get-AllFabCapacities #> -function Get-FabricCapacities { # Define aliases for the function for flexibility. # Define parameters for the function diff --git a/source/Public/Capacity/Get-FabricCapacity.ps1 b/source/Public/Capacity/Get-FabricCapacity.ps1 index 35161f36..3532e309 100644 --- a/source/Public/Capacity/Get-FabricCapacity.ps1 +++ b/source/Public/Capacity/Get-FabricCapacity.ps1 @@ -1,4 +1,4 @@ - +function Get-FabricCapacity { <# .SYNOPSIS Retrieves capacity details from a specified Microsoft Fabric workspace. @@ -14,20 +14,25 @@ The name of the capacity to retrieve. This parameter is optional. .EXAMPLE - Get-FabricCapacity -capacityId "capacity-12345" This example retrieves the capacity details for the capacity with ID "capacity-12345". + ```powershell + Get-FabricCapacity -capacityId "capacity-12345" + ``` + .EXAMPLE - Get-FabricCapacity -capacityName "MyCapacity" This example retrieves the capacity details for the capacity named "MyCapacity". + ```powershell + Get-FabricCapacity -capacityName "MyCapacity" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. Author: Tiago Balabuch #> -function Get-FabricCapacity { [CmdletBinding()] param ( [Parameter(Mandatory = $false)] diff --git a/source/Public/Capacity/Get-FabricCapacityRefreshables.ps1 b/source/Public/Capacity/Get-FabricCapacityRefreshables.ps1 index e486147a..5e292c5a 100644 --- a/source/Public/Capacity/Get-FabricCapacityRefreshables.ps1 +++ b/source/Public/Capacity/Get-FabricCapacityRefreshables.ps1 @@ -10,9 +10,11 @@ The Get-FabricCapacityRefreshables function retrieves the top refreshable capaci The number of top refreshable capacities to retrieve. This is a mandatory parameter. .EXAMPLE -Get-FabricCapacityRefreshables -top 5 + This example retrieves the top 5 refreshable capacities for the tenant. -This example retrieves the top 5 refreshable capacities for the tenant. + ```powershell + Get-FabricCapacityRefreshables -top 5 + ``` .NOTES The function retrieves the PowerBI access token and makes a GET request to the PowerBI API to retrieve the top refreshable capacities. It then returns the 'value' property of the response, which contains the capacities. diff --git a/source/Public/Capacity/Get-FabricCapacitySkus.ps1 b/source/Public/Capacity/Get-FabricCapacitySkus.ps1 index 4a3668a0..8d21d448 100644 --- a/source/Public/Capacity/Get-FabricCapacitySkus.ps1 +++ b/source/Public/Capacity/Get-FabricCapacitySkus.ps1 @@ -1,4 +1,3 @@ - function Get-FabricCapacitySkus { <# .SYNOPSIS @@ -17,8 +16,11 @@ Specifies the name of the resource group in which the Fabric capacity is located Specifies the capacity to retrieve information for. If not provided, all capacities will be retrieved. .EXAMPLE -Get-FabricCapacitySkus -capacity "exampleCapacity" -Retrieves the fabric capacity information for the specified capacity. + Retrieves the fabric capacity information for the specified capacity. + + ```powershell + Get-FabricCapacitySkus -capacity "exampleCapacity" + ``` .NOTES diff --git a/source/Public/Capacity/Get-FabricCapacityState.ps1 b/source/Public/Capacity/Get-FabricCapacityState.ps1 index fd3b8548..843e2968 100644 --- a/source/Public/Capacity/Get-FabricCapacityState.ps1 +++ b/source/Public/Capacity/Get-FabricCapacityState.ps1 @@ -16,9 +16,11 @@ The resource group. This is a mandatory parameter. This is a parameter found in The capacity. This is a mandatory parameter. This is a parameter found in Azure, not Fabric. .EXAMPLE -Get-FabricCapacityState -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" + This example retrieves the state of a specific capacity given the subscription ID, resource group, and capacity. -This example retrieves the state of a specific capacity given the subscription ID, resource group, and capacity. + ```powershell + Get-FabricCapacityState -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" + ``` .NOTES The function checks if the Azure token is null. If it is, it connects to the Azure account and retrieves the token. It then defines the headers for the GET request and the URL for the GET request. Finally, it makes the GET request and returns the response. diff --git a/source/Public/Capacity/Get-FabricCapacityTenantOverrides.ps1 b/source/Public/Capacity/Get-FabricCapacityTenantOverrides.ps1 index cb40d5bf..bb078a96 100644 --- a/source/Public/Capacity/Get-FabricCapacityTenantOverrides.ps1 +++ b/source/Public/Capacity/Get-FabricCapacityTenantOverrides.ps1 @@ -7,9 +7,11 @@ Retrieves the tenant overrides for all capacities. The Get-FabricCapacityTenantOverrides function retrieves the tenant overrides for all capacities. It supports multiple aliases for flexibility. .EXAMPLE -Get-FabricCapacityTenantOverrides + This example retrieves the tenant overrides for all capacities. -This example retrieves the tenant overrides for all capacities. + ```powershell + Get-FabricCapacityTenantOverrides + ``` .NOTES The function retrieves the PowerBI access token and makes a GET request to the Fabric API to retrieve the tenant overrides for all capacities. It then returns the response of the GET request. diff --git a/source/Public/Capacity/Get-FabricCapacityWorkload.ps1 b/source/Public/Capacity/Get-FabricCapacityWorkload.ps1 index cc841ba8..f0049884 100644 --- a/source/Public/Capacity/Get-FabricCapacityWorkload.ps1 +++ b/source/Public/Capacity/Get-FabricCapacityWorkload.ps1 @@ -10,9 +10,11 @@ The Get-FabricCapacityWorkload function retrieves the workloads for a specific c The ID of the capacity. This is a mandatory parameter. .EXAMPLE -Get-FabricCapacityWorkload -capacityID "your-capacity-id" + This example retrieves the workloads for a specific capacity given the capacity ID and authentication token. -This example retrieves the workloads for a specific capacity given the capacity ID and authentication token. + ```powershell + Get-FabricCapacityWorkload -capacityID "your-capacity-id" + ``` .NOTES The function retrieves the PowerBI access token and makes a GET request to the PowerBI API to retrieve the workloads for the specified capacity. It then returns the 'value' property of the response, which contains the workloads. diff --git a/source/Public/Capacity/Resume-FabricCapacity.ps1 b/source/Public/Capacity/Resume-FabricCapacity.ps1 index 2cf33d38..3bd9ae21 100644 --- a/source/Public/Capacity/Resume-FabricCapacity.ps1 +++ b/source/Public/Capacity/Resume-FabricCapacity.ps1 @@ -1,32 +1,32 @@ function Resume-FabricCapacity { <# -.SYNOPSIS -Resumes a capacity. + .SYNOPSIS + Resumes a capacity. -.DESCRIPTION -The Resume-FabricCapacity function resumes a capacity. It supports multiple aliases for flexibility. + .DESCRIPTION + The Resume-FabricCapacity function resumes a capacity. It supports multiple aliases for flexibility. -.PARAMETER subscriptionID -The the ID of the subscription. This is a mandatory parameter. This is a parameter found in Azure, not Fabric. + .PARAMETER subscriptionID + The the ID of the subscription. This is a mandatory parameter. This is a parameter found in Azure, not Fabric. -.PARAMETER resourcegroup -The resource group. This is a mandatory parameter. This is a parameter found in Azure, not Fabric. + .PARAMETER resourcegroup + The resource group. This is a mandatory parameter. This is a parameter found in Azure, not Fabric. -.PARAMETER capacity -The capacity. This is a mandatory parameter. This is a parameter found in Azure, not Fabric. + .PARAMETER capacity + The capacity. This is a mandatory parameter. This is a parameter found in Azure, not Fabric. -.EXAMPLE -Resume-FabricCapacity -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" + .EXAMPLE + This example resumes a capacity given the subscription ID, resource group, and capacity. -This example resumes a capacity given the subscription ID, resource group, and capacity. + ```powershell + Resume-FabricCapacity -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" + ``` -.NOTES -The function defines parameters for the subscription ID, resource group, and capacity. If the 'azToken' environment variable is null, it connects to the Azure account and sets the 'azToken' environment variable. It then defines the headers for the request, defines the URI for the request, and makes a GET request to the URI. - -Author: Ioana Bouariu + .NOTES + The function defines parameters for the subscription ID, resource group, and capacity. If the 'azToken' environment variable is null, it connects to the Azure account and sets the 'azToken' environment variable. It then defines the headers for the request, defines the URI for the request, and makes a GET request to the URI. + Author: Ioana Bouariu #> - # Define aliases for the function for flexibility. [Alias("Resume-FabCapacity")] [CmdletBinding(SupportsShouldProcess)] diff --git a/source/Public/Capacity/Suspend-FabricCapacity.ps1 b/source/Public/Capacity/Suspend-FabricCapacity.ps1 index 65c8c7b8..6880dbf3 100644 --- a/source/Public/Capacity/Suspend-FabricCapacity.ps1 +++ b/source/Public/Capacity/Suspend-FabricCapacity.ps1 @@ -1,6 +1,5 @@ -# This function suspends a capacity. function Suspend-FabricCapacity { - <# + <# .SYNOPSIS Suspends a capacity. @@ -17,9 +16,11 @@ The resource group. This is a mandatory parameter. This is a parameter found in The the capacity. This is a mandatory parameter. This is a parameter found in Azure, not Fabric. .EXAMPLE -Suspend-FabricCapacity -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" + This example suspends a capacity given the subscription ID, resource group, and capacity. -This example suspends a capacity given the subscription ID, resource group, and capacity. + ```powershell + Suspend-FabricCapacity -subscriptionID "your-subscription-id" -resourcegroupID "your-resource-group" -capacityID "your-capacity" + ``` .NOTES The function defines parameters for the subscription ID, resource group, and capacity. If the 'azToken' environment variable is null, it connects to the Azure account and sets the 'azToken' environment variable. It then defines the headers for the request, defines the URI for the request, and makes a GET request to the URI. @@ -27,7 +28,6 @@ The function defines parameters for the subscription ID, resource group, and cap Author: Ioana Bouariu #> - # Define aliases for the function for flexibility. [Alias("Suspend-PowerBICapacity", "Suspend-FabCapacity")] [CmdletBinding(SupportsShouldProcess)] diff --git a/source/Public/Config/Get-FabricConfig.ps1 b/source/Public/Config/Get-FabricConfig.ps1 index a7654333..6121940e 100644 --- a/source/Public/Config/Get-FabricConfig.ps1 +++ b/source/Public/Config/Get-FabricConfig.ps1 @@ -10,14 +10,18 @@ Gets the configuration for use with all functions in the PSFabricTools module. The name of the configuration to be retrieved. .EXAMPLE -PS> Get-FabricConfig + Gets all configuration values for the PSFabricTools module and outputs them. -Gets all the configuration values for the PSFabricTools module and outputs them. + ```powershell + Get-FabricConfig + ``` .EXAMPLE -PS> Get-FabricConfig -ConfigName BaseUrl + Gets the BaseUrl configuration value for the PSFabricTools module. -Gets the BaseUrl configuration value for the PSFabricTools module. + ```powershell + Get-FabricConfig -ConfigName BaseUrl + ``` .NOTES diff --git a/source/Public/Config/Set-FabricConfig.ps1 b/source/Public/Config/Set-FabricConfig.ps1 index 1879df43..9e8f085a 100644 --- a/source/Public/Config/Set-FabricConfig.ps1 +++ b/source/Public/Config/Set-FabricConfig.ps1 @@ -1,4 +1,5 @@ -<# +function Set-FabricConfig { + <# .SYNOPSIS Register the configuration for use with all functions in the PSFabricTools module. @@ -18,21 +19,23 @@ Defaults to api.powerbi.com If set, the configuration will not be persisted to the registry. .EXAMPLE -PS> Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' + Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module. -Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module. + ```powershell + Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' + ``` .EXAMPLE -PS> Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -SkipPersist + Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module, but does not persist the values. -Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module - but it does not persist the values, only uses them for the current session. + ```powershell + Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -SkipPersist + ``` .NOTES Author: Jess Pomfret #> - -function Set-FabricConfig { [CmdletBinding(SupportsShouldProcess)] param ( [guid]$WorkspaceGUID, diff --git a/source/Public/Connect-FabricAccount.ps1 b/source/Public/Connect-FabricAccount.ps1 index 9f219425..cb9f4d1f 100644 --- a/source/Public/Connect-FabricAccount.ps1 +++ b/source/Public/Connect-FabricAccount.ps1 @@ -23,21 +23,27 @@ function Connect-FabricAccount { A switch parameter. If provided, the function resets the Fabric authentication token. .EXAMPLE - Connect-FabricAccount -TenantId '12345678-1234-1234-1234-123456789012' + Connects to the stated Tenant with existing credentials - Connects to the stated Tenant with exisitng credentials + ```powershell + Connect-FabricAccount -TenantId '12345678-1234-1234-1234-123456789012' + ``` .EXAMPLE + Prompts for Service Principal id and secret and connects as that Service Principal + + ```powershell $credential = Get-Credential Connect-FabricAccount -TenantId 'xxx' -credential $credential - - Prompts for Service Principal id and secret and connects as that Service Principal + ``` .EXAMPLE - Connect-FabricAccount -TenantId 'xxx' -ServicePrincipalId 'appId' -ServicePrincipalSecret $secret - Connects as Service Principal using id and secret + ```powershell + Connect-FabricAccount -TenantId 'xxx' -ServicePrincipalId 'appId' -ServicePrincipalSecret $secret + ``` + .OUTPUTS None. This function does not return any output. diff --git a/source/Public/Copy Job/Get-FabricCopyJob.ps1 b/source/Public/Copy Job/Get-FabricCopyJob.ps1 index de135555..0710308b 100644 --- a/source/Public/Copy Job/Get-FabricCopyJob.ps1 +++ b/source/Public/Copy Job/Get-FabricCopyJob.ps1 @@ -17,13 +17,19 @@ function Get-FabricCopyJob { The name of the CopyJob to retrieve. This parameter is optional. .EXAMPLE - FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "CopyJob-67890" This example retrieves the CopyJob details for the CopyJob with ID "CopyJob-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "CopyJob-67890" + ``` + .EXAMPLE - FabricCopyJob -WorkspaceId "workspace-12345" -CopyJob "My CopyJob" This example retrieves the CopyJob details for the CopyJob named "My CopyJob" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJob "My CopyJob" + ``` + .NOTES Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. Calls `Confirm-TokenState` to ensure token validity before making the API request. diff --git a/source/Public/Copy Job/Get-FabricCopyJobDefinition.ps1 b/source/Public/Copy Job/Get-FabricCopyJobDefinition.ps1 index f779ee60..ac3a0daf 100644 --- a/source/Public/Copy Job/Get-FabricCopyJobDefinition.ps1 +++ b/source/Public/Copy Job/Get-FabricCopyJobDefinition.ps1 @@ -1,3 +1,4 @@ +function Get-FabricCopyJobDefinition { <# .SYNOPSIS Retrieves the definition of a Copy Job from a specific workspace in Microsoft Fabric. @@ -16,9 +17,11 @@ It supports both synchronous and asynchronous operations, with detailed logging (Optional) Specifies the format of the Copy Job definition. For example, 'json' or 'xml'. .EXAMPLE -Get-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" + Retrieves the definition of the Copy Job with ID `67890` from the workspace with ID `12345`. -Retrieves the definition of the Copy Job with ID `67890` from the workspace with ID `12345`. + ```powershell + Get-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -29,7 +32,6 @@ Retrieves the definition of the Copy Job with ID `67890` from the workspace with Author: Tiago Balabuch #> -function Get-FabricCopyJobDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Copy Job/New-FabricCopyJob.ps1 b/source/Public/Copy Job/New-FabricCopyJob.ps1 index 42c22752..48a80ae9 100644 --- a/source/Public/Copy Job/New-FabricCopyJob.ps1 +++ b/source/Public/Copy Job/New-FabricCopyJob.ps1 @@ -1,3 +1,4 @@ +function New-FabricCopyJob { <# .SYNOPSIS Creates a new copy job in a specified Microsoft Fabric workspace. @@ -22,7 +23,11 @@ Optional file path to the platform definition file. .EXAMPLE + Creates a new copy job named "New Copy Job" in the workspace with ID "workspace-12345". + + ```powershell New-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobName "New Copy Job" -CopyJobDescription "Description of the new copy job" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -30,7 +35,6 @@ Author: Tiago Balabuch #> -function New-FabricCopyJob { [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Copy Job/Remove-FabricCopyJob.ps1 b/source/Public/Copy Job/Remove-FabricCopyJob.ps1 index 08c9d616..82d9e922 100644 --- a/source/Public/Copy Job/Remove-FabricCopyJob.ps1 +++ b/source/Public/Copy Job/Remove-FabricCopyJob.ps1 @@ -1,3 +1,4 @@ +function Remove-FabricCopyJob { <# .SYNOPSIS Deletes a Copy Job from a specified Microsoft Fabric workspace. @@ -13,16 +14,18 @@ The unique identifier of the Copy Job to delete. .EXAMPLE - Remove-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "copyjob-67890" Deletes the Copy Job with ID "copyjob-67890" from the workspace with ID "workspace-12345". + ```powershell + Remove-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "copyjob-67890" + ``` + .NOTES - Requires the `$FabricConfig` global configuration, which must include `BaseUrl` and `FabricHeaders`. - Ensures token validity by invoking `Confirm-TokenState` before making the API request. Author: Tiago Balabuch #> -function Remove-FabricCopyJob { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Copy Job/Update-FabricCopyJob.ps1 b/source/Public/Copy Job/Update-FabricCopyJob.ps1 index 17a99a64..7b31ebf0 100644 --- a/source/Public/Copy Job/Update-FabricCopyJob.ps1 +++ b/source/Public/Copy Job/Update-FabricCopyJob.ps1 @@ -1,3 +1,5 @@ +function Update-FabricCopyJob +{ <# .SYNOPSIS Updates an existing Copy Job in a specified Microsoft Fabric workspace. @@ -19,17 +21,18 @@ An optional new description for the Copy Job. .EXAMPLE - Update-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "copyjob-67890" -CopyJobName "Updated Copy Job" -CopyJobDescription "Updated description" Updates the Copy Job with ID "copyjob-67890" in the workspace "workspace-12345" with a new name and description. + ```powershell + Update-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "copyjob-67890" -CopyJobName "Updated Copy Job" -CopyJobDescription "Updated description" + ``` + .NOTES - Requires the `$FabricConfig` global configuration, which includes `BaseUrl` and `FabricHeaders`. - Ensures token validity by calling `Confirm-TokenState` before making the API request. Author: Tiago Balabuch #> -function Update-FabricCopyJob -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Copy Job/Update-FabricCopyJobDefinition.ps1 b/source/Public/Copy Job/Update-FabricCopyJobDefinition.ps1 index afeef789..c88212a1 100644 --- a/source/Public/Copy Job/Update-FabricCopyJobDefinition.ps1 +++ b/source/Public/Copy Job/Update-FabricCopyJobDefinition.ps1 @@ -1,3 +1,4 @@ +function Update-FabricCopyJobDefinition { <# .SYNOPSIS Updates the definition of a Copy Job in a Microsoft Fabric workspace. @@ -19,14 +20,18 @@ The Copy Job content and platform-specific definitions can be provided as file p (Optional) The file path to the platform-specific definition file for the Copy Job. The file content will be encoded as Base64. .EXAMPLE -Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb" + Updates the content of the Copy Job with ID `67890` in the workspace `12345` using the specified Copy Job file. -Updates the content of the Copy Job with ID `67890` in the workspace `12345` using the specified Copy Job file. + ```powershell + Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb" + ``` .EXAMPLE -Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb" -CopyJobPathPlatformDefinition "C:\CopyJobs\Platform.json" + Updates both the content and platform-specific definition of the Copy Job with ID `67890` in the workspace `12345`. -Updates both the content and platform-specific definition of the Copy Job with ID `67890` in the workspace `12345`. + ```powershell + Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb" -CopyJobPathPlatformDefinition "C:\CopyJobs\Platform.json" + ``` .NOTES - Requires the `$FabricConfig` global configuration, which must include `BaseUrl` and `FabricHeaders`. @@ -36,8 +41,6 @@ Updates both the content and platform-specific definition of the Copy Job with I Author: Tiago Balabuch #> - -function Update-FabricCopyJobDefinition { [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Dashboard/Get-FabricDashboard.ps1 b/source/Public/Dashboard/Get-FabricDashboard.ps1 index bfc229ab..5cd972ea 100644 --- a/source/Public/Dashboard/Get-FabricDashboard.ps1 +++ b/source/Public/Dashboard/Get-FabricDashboard.ps1 @@ -1,3 +1,4 @@ +function Get-FabricDashboard { <# .SYNOPSIS Retrieves dashboards from a specified workspace. @@ -10,17 +11,18 @@ The ID of the workspace from which to retrieve dashboards. This parameter is mandatory. .EXAMPLE - Get-FabricDashboard -WorkspaceId "12345" This example retrieves all dashboards from the workspace with ID "12345". + ```powershell + Get-FabricDashboard -WorkspaceId "12345" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. Author: Tiago Balabuch #> - -function Get-FabricDashboard { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Data Pipeline/Get-FabricDataPipeline.ps1 b/source/Public/Data Pipeline/Get-FabricDataPipeline.ps1 index 251db3e2..27277c17 100644 --- a/source/Public/Data Pipeline/Get-FabricDataPipeline.ps1 +++ b/source/Public/Data Pipeline/Get-FabricDataPipeline.ps1 @@ -17,13 +17,19 @@ function Get-FabricDataPipeline { The name of the Data Pipeline to retrieve. This parameter is optional. .EXAMPLE - Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineId "Data Pipeline-67890" This example retrieves the Data Pipeline details for the Data Pipeline with ID "Data Pipeline-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineId "Data Pipeline-67890" + ``` + .EXAMPLE - Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineName "My Data Pipeline" This example retrieves the Data Pipeline details for the Data Pipeline named "My Data Pipeline" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineName "My Data Pipeline" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. diff --git a/source/Public/Data Pipeline/New-FabricDataPipeline.ps1 b/source/Public/Data Pipeline/New-FabricDataPipeline.ps1 index 2b7b020e..96f07620 100644 --- a/source/Public/Data Pipeline/New-FabricDataPipeline.ps1 +++ b/source/Public/Data Pipeline/New-FabricDataPipeline.ps1 @@ -1,3 +1,5 @@ +function New-FabricDataPipeline +{ <# .SYNOPSIS Creates a new DataPipeline in a specified Microsoft Fabric workspace. @@ -17,18 +19,18 @@ An optional description for the DataPipeline. .EXAMPLE - New-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineName "New DataPipeline" This example creates a new DataPipeline named "New DataPipeline" in the workspace with ID "workspace-12345" and uploads the definition file from the specified path. + ```powershell + New-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineName "New DataPipeline" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. Author: Tiago Balabuch #> - -function New-FabricDataPipeline -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Data Pipeline/Remove-FabricDataPipeline.ps1 b/source/Public/Data Pipeline/Remove-FabricDataPipeline.ps1 index d02c6edd..c6bda6b5 100644 --- a/source/Public/Data Pipeline/Remove-FabricDataPipeline.ps1 +++ b/source/Public/Data Pipeline/Remove-FabricDataPipeline.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricDataPipeline +{ <# .SYNOPSIS Removes a DataPipeline from a specified Microsoft Fabric workspace. @@ -13,18 +15,18 @@ The unique identifier of the DataPipeline to be removed. .EXAMPLE - Remove-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineId "pipeline-67890" This example removes the DataPipeline with ID "pipeline-67890" from the workspace with ID "workspace-12345". + ```powershell + Remove-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineId "pipeline-67890" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. Author: Tiago Balabuch #> - -function Remove-FabricDataPipeline -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Data Pipeline/Update-FabricDataPipeline.ps1 b/source/Public/Data Pipeline/Update-FabricDataPipeline.ps1 index 43c0fd6a..c4732e89 100644 --- a/source/Public/Data Pipeline/Update-FabricDataPipeline.ps1 +++ b/source/Public/Data Pipeline/Update-FabricDataPipeline.ps1 @@ -1,3 +1,5 @@ +function Update-FabricDataPipeline +{ <# .SYNOPSIS Updates an existing DataPipeline in a specified Microsoft Fabric workspace. @@ -19,17 +21,18 @@ An optional new description for the DataPipeline. .EXAMPLE - Update-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineId "pipeline-67890" -DataPipelineName "Updated DataPipeline" -DataPipelineDescription "Updated description" This example updates the DataPipeline with ID "pipeline-67890" in the workspace with ID "workspace-12345" with a new name and description. + ```powershell + Update-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineId "pipeline-67890" -DataPipelineName "Updated DataPipeline" -DataPipelineDescription "Updated description" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. Author: Tiago Balabuch #> -function Update-FabricDataPipeline -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Datamart/Get-FabricDatamart.ps1 b/source/Public/Datamart/Get-FabricDatamart.ps1 index 46b83381..10485a85 100644 --- a/source/Public/Datamart/Get-FabricDatamart.ps1 +++ b/source/Public/Datamart/Get-FabricDatamart.ps1 @@ -17,9 +17,12 @@ function Get-FabricDatamart { The name of the specific datamart to retrieve. This parameter is optional. .EXAMPLE - Get-FabricDatamart -WorkspaceId "12345" This example retrieves all datamarts from the workspace with ID "12345". + ```powershell + Get-FabricDatamart -WorkspaceId "12345" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. diff --git a/source/Public/Deployment Pipeline/Add-FabricWorkspaceToStage.ps1 b/source/Public/Deployment Pipeline/Add-FabricWorkspaceToStage.ps1 index 6dc4d8de..d720b51f 100644 --- a/source/Public/Deployment Pipeline/Add-FabricWorkspaceToStage.ps1 +++ b/source/Public/Deployment Pipeline/Add-FabricWorkspaceToStage.ps1 @@ -1,3 +1,4 @@ +function Add-FabricWorkspaceToStage { <# .SYNOPSIS Assigns a workspace to a deployment pipeline stage. @@ -16,9 +17,11 @@ Required. The ID of the deployment pipeline stage. Required. The ID of the workspace to assign to the stage. .EXAMPLE -Add-FabricWorkspaceToStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" -WorkspaceId "GUID-GUID-GUID-GUID" + Assigns the specified workspace to the deployment pipeline stage. -Assigns the specified workspace to the deployment pipeline stage. + ```powershell + Add-FabricWorkspaceToStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" -WorkspaceId "GUID-GUID-GUID-GUID" + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -33,8 +36,6 @@ Assigns the specified workspace to the deployment pipeline stage. Author: Kamil Nowinski #> - -function Add-FabricWorkspaceToStage { [CmdletBinding()] param( [Parameter(Mandatory = $true)] diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipeline.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipeline.ps1 index 462752c2..d7080a34 100644 --- a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipeline.ps1 +++ b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipeline.ps1 @@ -1,3 +1,4 @@ +function Get-FabricDeploymentPipeline { <# .SYNOPSIS Retrieves deployment pipeline(s) from Microsoft Fabric. @@ -14,14 +15,18 @@ Optional. The ID of a specific deployment pipeline to retrieve. If not provided, Optional. The display name of a specific deployment pipeline to retrieve. If provided, it will filter the results to match this name. .EXAMPLE -Get-FabricDeploymentPipeline + Retrieves all deployment pipelines that the user can access. -Retrieves all deployment pipelines that the user can access. + ```powershell + Get-FabricDeploymentPipeline + ``` .EXAMPLE -Get-FabricDeploymentPipeline -DeploymentPipelineId "GUID-GUID-GUID-GUID" + Retrieves a specific deployment pipeline with detailed information including its stages. -Retrieves a specific deployment pipeline with detailed information including its stages. + ```powershell + Get-FabricDeploymentPipeline -DeploymentPipelineId "GUID-GUID-GUID-GUID" + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -31,8 +36,6 @@ Retrieves a specific deployment pipeline with detailed information including its Author: Kamil Nowinski #> - -function Get-FabricDeploymentPipeline { [CmdletBinding()] param( [Parameter(Mandatory = $false)] diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineOperation.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineOperation.ps1 index f2e3d190..7afefa9a 100644 --- a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineOperation.ps1 +++ b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineOperation.ps1 @@ -1,3 +1,4 @@ +function Get-FabricDeploymentPipelineOperation { <# .SYNOPSIS Retrieves details of a specific deployment pipeline operation. @@ -13,9 +14,11 @@ Required. The ID of the deployment pipeline. Required. The ID of the operation to retrieve. .EXAMPLE -Get-FabricDeploymentPipelineOperation -DeploymentPipelineId "GUID-GUID-GUID-GUID" -OperationId "GUID-GUID-GUID-GUID" + Retrieves details of a specific deployment operation, including its execution plan and status. -Retrieves details of a specific deployment operation, including its execution plan and status. + ```powershell + Get-FabricDeploymentPipelineOperation -DeploymentPipelineId "GUID-GUID-GUID-GUID" -OperationId "GUID-GUID-GUID-GUID" + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,8 +33,6 @@ Retrieves details of a specific deployment operation, including its execution pl Author: Kamil Nowinski #> - -function Get-FabricDeploymentPipelineOperation { [CmdletBinding()] param( [Parameter(Mandatory = $true)] diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineRoleAssignments.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineRoleAssignments.ps1 index 714b5418..8405d9c3 100644 --- a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineRoleAssignments.ps1 +++ b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineRoleAssignments.ps1 @@ -1,3 +1,4 @@ +function Get-FabricDeploymentPipelineRoleAssignments { <# .SYNOPSIS Returns a list of deployment pipeline role assignments. @@ -10,9 +11,11 @@ The function automatically handles pagination and returns all available role ass Required. The ID of the deployment pipeline to get role assignments for. .EXAMPLE -Get-FabricDeploymentPipelineRoleAssignments -DeploymentPipelineId "GUID-GUID-GUID-GUID" + Returns all role assignments for the specified deployment pipeline. -Returns all role assignments for the specified deployment pipeline. + ```powershell + Get-FabricDeploymentPipelineRoleAssignments -DeploymentPipelineId "GUID-GUID-GUID-GUID" + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -22,8 +25,6 @@ Returns all role assignments for the specified deployment pipeline. Author: Kamil Nowinski #> - -function Get-FabricDeploymentPipelineRoleAssignments { [CmdletBinding()] param( [Parameter(Mandatory = $true)] diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStage.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStage.ps1 index 88c69713..3a60c22d 100644 --- a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStage.ps1 +++ b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStage.ps1 @@ -1,3 +1,4 @@ +function Get-FabricDeploymentPipelineStage { <# .SYNOPSIS Retrieves details of deployment pipeline stages. @@ -14,14 +15,18 @@ Required. The ID of the deployment pipeline. Optional. The ID of the specific stage to retrieve. If not provided, returns all stages in the pipeline. .EXAMPLE -Get-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" + Retrieves details of a specific deployment pipeline stage, including its workspace assignment and settings. -Retrieves details of a specific deployment pipeline stage, including its workspace assignment and settings. + ```powershell + Get-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" + ``` .EXAMPLE -Get-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" + Retrieves a list of all stages in the specified deployment pipeline. -Retrieves a list of all stages in the specified deployment pipeline. + ```powershell + Get-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -35,8 +40,6 @@ Retrieves a list of all stages in the specified deployment pipeline. Author: Kamil Nowinski #> - -function Get-FabricDeploymentPipelineStage { [CmdletBinding()] param( [Parameter(Mandatory = $true)] diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStageItem.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStageItem.ps1 index e43d5467..afaaae82 100644 --- a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStageItem.ps1 +++ b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStageItem.ps1 @@ -1,3 +1,4 @@ +function Get-FabricDeploymentPipelineStageItem { <# .SYNOPSIS Retrieves the supported items from the workspace assigned to a specific stage of a deployment pipeline. @@ -14,9 +15,11 @@ Required. The ID of the deployment pipeline. Required. The ID of the stage to retrieve items from. .EXAMPLE -Get-FabricDeploymentPipelineStageItem -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" + Retrieves all items from the specified stage of the deployment pipeline. -Retrieves all items from the specified stage of the deployment pipeline. + ```powershell + Get-FabricDeploymentPipelineStageItem -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -31,8 +34,6 @@ Retrieves all items from the specified stage of the deployment pipeline. Author: Kamil Nowinski #> - -function Get-FabricDeploymentPipelineStageItem { [CmdletBinding()] param( [Parameter(Mandatory = $true)] diff --git a/source/Public/Deployment Pipeline/New-FabricDeploymentPipeline.ps1 b/source/Public/Deployment Pipeline/New-FabricDeploymentPipeline.ps1 index 120df923..baf79663 100644 --- a/source/Public/Deployment Pipeline/New-FabricDeploymentPipeline.ps1 +++ b/source/Public/Deployment Pipeline/New-FabricDeploymentPipeline.ps1 @@ -1,3 +1,4 @@ +function New-FabricDeploymentPipeline { <# .SYNOPSIS Creates a new deployment pipeline. @@ -19,27 +20,14 @@ Required. An array of hashtables containing stage configurations. Each stage sho - IsPublic (boolean) .EXAMPLE -$stages = @( - @{ - DisplayName = "Development" - Description = "Development stage description" - IsPublic = $false - }, - @{ - DisplayName = "Test" - Description = "Test stage description" - IsPublic = $false - }, - @{ - DisplayName = "Production" - Description = "Production stage description" - IsPublic = $true - } -) - -New-FabricDeploymentPipeline -DisplayName "My Deployment Pipeline" -Description "My pipeline description" -Stages $stages + Creates a new deployment pipeline with two stages. -Creates a new deployment pipeline with three stages: Development, Test, and Production. + ```powershell + New-FabricDeploymentPipeline -DisplayName "My Deployment Pipeline" -Description "This is a test deployment pipeline" -Stages @( + @{ DisplayName = "Stage 1"; Description = "First stage"; IsPublic = $true }, + @{ DisplayName = "Stage 2"; Description = "Second stage"; IsPublic = $false } + ) + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -49,8 +37,6 @@ Creates a new deployment pipeline with three stages: Development, Test, and Prod Author: Kamil Nowinski #> - -function New-FabricDeploymentPipeline { [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory = $true)] diff --git a/source/Public/Deployment Pipeline/Remove-FabricDeploymentPipeline.ps1 b/source/Public/Deployment Pipeline/Remove-FabricDeploymentPipeline.ps1 index 305c95fd..dcfaf008 100644 --- a/source/Public/Deployment Pipeline/Remove-FabricDeploymentPipeline.ps1 +++ b/source/Public/Deployment Pipeline/Remove-FabricDeploymentPipeline.ps1 @@ -1,3 +1,4 @@ +function Remove-FabricDeploymentPipeline { <# .SYNOPSIS Deletes a specified deployment pipeline. @@ -10,9 +11,11 @@ This operation requires admin deployment pipelines role and will fail if there's Required. The ID of the deployment pipeline to delete. .EXAMPLE -Remove-FabricDeploymentPipeline -DeploymentPipelineId "GUID-GUID-GUID-GUID" + Deletes the specified deployment pipeline. -Deletes the specified deployment pipeline. + ```powershell + Remove-FabricDeploymentPipeline -DeploymentPipelineId "GUID-GUID-GUID-GUID" + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -22,8 +25,6 @@ Deletes the specified deployment pipeline. Author: Kamil Nowinski #> - -function Remove-FabricDeploymentPipeline { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param( [Parameter(Mandatory = $true)] diff --git a/source/Public/Deployment Pipeline/Remove-FabricWorkspaceFromStage.ps1 b/source/Public/Deployment Pipeline/Remove-FabricWorkspaceFromStage.ps1 index 65d9f0e2..abfd0b5a 100644 --- a/source/Public/Deployment Pipeline/Remove-FabricWorkspaceFromStage.ps1 +++ b/source/Public/Deployment Pipeline/Remove-FabricWorkspaceFromStage.ps1 @@ -1,3 +1,4 @@ +function Remove-FabricWorkspaceFromStage { <# .SYNOPSIS Removes a workspace from a deployment pipeline stage. @@ -13,9 +14,11 @@ Required. The ID of the deployment pipeline. Required. The ID of the deployment pipeline stage. .EXAMPLE -Remove-FabricWorkspaceFromStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" + Removes the workspace from the specified deployment pipeline stage. -Removes the workspace from the specified deployment pipeline stage. + ```powershell + Remove-FabricWorkspaceFromStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -26,8 +29,6 @@ Removes the workspace from the specified deployment pipeline stage. Author: Kamil Nowinski #> - -function Remove-FabricWorkspaceFromStage { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param( [Parameter(Mandatory = $true)] diff --git a/source/Public/Deployment Pipeline/Start-FabricDeploymentPipelineStage.ps1 b/source/Public/Deployment Pipeline/Start-FabricDeploymentPipelineStage.ps1 index f75b42c9..be1cacde 100644 --- a/source/Public/Deployment Pipeline/Start-FabricDeploymentPipelineStage.ps1 +++ b/source/Public/Deployment Pipeline/Start-FabricDeploymentPipelineStage.ps1 @@ -1,3 +1,4 @@ +function Start-FabricDeploymentPipelineStage { <# .SYNOPSIS Deploys items from one stage to another in a deployment pipeline. @@ -28,30 +29,34 @@ Optional. A note describing the deployment. Limited to 1024 characters. Optional. If specified, the function will not wait for the deployment to complete and will return immediately. .EXAMPLE -$params = @{ - DeploymentPipelineId = "GUID-GUID-GUID-GUID" - SourceStageId = "GUID-GUID-GUID-GUID" - TargetStageId = "GUID-GUID-GUID-GUID" - Note = "Deploying business ready items" -} -Start-FabricDeploymentPipelineStage @params - -Deploys all supported items from the source stage to the target stage. - -.EXAMPLE -$items = @( - @{ - sourceItemId = "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b" - itemType = "Datamart" - }, - @{ - sourceItemId = "1a201f2a-d1d8-45c0-8c61-1676338517de" - itemType = "SemanticModel" + Deploys all supported items from the source stage to the target stage. + + ```powershell + $params = @{ + DeploymentPipelineId = "GUID-GUID-GUID-GUID" + SourceStageId = "GUID-GUID-GUID-GUID" + TargetStageId = "GUID-GUID-GUID-GUID" + Note = "Deploying business ready items" } -) -Start-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -SourceStageId "GUID-GUID-GUID-GUID" -TargetStageId "GUID-GUID-GUID-GUID" -Items $items -Note "Deploying specific items" + Start-FabricDeploymentPipelineStage @params + ``` -Deploys specific items from the source stage to the target stage. +.EXAMPLE + Deploys specific items from the source stage to the target stage. + + ```powershell + $items = @( + @{ + sourceItemId = "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b" + itemType = "Datamart" + }, + @{ + sourceItemId = "1a201f2a-d1d8-45c0-8c61-1676338517de" + itemType = "SemanticModel" + } + ) + Start-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -SourceStageId "GUID-GUID-GUID-GUID" -TargetStageId "GUID-GUID-GUID-GUID" -Items $items -Note "Deploying specific items" + ``` .NOTES - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -63,8 +68,6 @@ Deploys specific items from the source stage to the target stage. Author: Kamil Nowinski #> - -function Start-FabricDeploymentPipelineStage { [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory = $true)] diff --git a/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentByCapacity.ps1 b/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentByCapacity.ps1 index f4c818ab..ca4ceca6 100644 --- a/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentByCapacity.ps1 +++ b/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentByCapacity.ps1 @@ -1,3 +1,4 @@ +function Add-FabricDomainWorkspaceAssignmentByCapacity { <# .SYNOPSIS Assigns workspaces to a Fabric domain based on specified capacities. @@ -12,9 +13,11 @@ The unique identifier of the Fabric domain to which the workspaces will be assig An array of capacity IDs used to assign workspaces to the domain. .EXAMPLE -Add-FabricDomainWorkspaceAssignmentByCapacity -DomainId "12345" -CapacitiesIds @("capacity1", "capacity2") + Assigns workspaces to the domain with ID "12345" based on the specified capacities. -Assigns workspaces to the domain with ID "12345" based on the specified capacities. + ```powershell + Add-FabricDomainWorkspaceAssignmentByCapacity -DomainId "12345" -CapacitiesIds @("capacity1", "capacity2") + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -22,8 +25,6 @@ Assigns workspaces to the domain with ID "12345" based on the specified capaciti Author: Tiago Balabuch #> - -function Add-FabricDomainWorkspaceAssignmentByCapacity { [CmdletBinding()] [Alias("Assign-FabricDomainWorkspaceByCapacity")] param ( diff --git a/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentById.ps1 b/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentById.ps1 index 2bd59ae4..a0f9f268 100644 --- a/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentById.ps1 +++ b/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentById.ps1 @@ -1,3 +1,4 @@ +function Add-FabricDomainWorkspaceAssignmentById { <# .SYNOPSIS Assigns workspaces to a specified domain in Microsoft Fabric by their IDs. @@ -12,9 +13,11 @@ The ID of the domain to which workspaces will be assigned. This parameter is man An array of workspace IDs to be assigned to the domain. This parameter is mandatory. .EXAMPLE -Add-FabricDomainWorkspaceAssignmentById -DomainId "12345" -WorkspaceIds @("ws1", "ws2", "ws3") + Assigns the workspaces with IDs "ws1", "ws2", and "ws3" to the domain with ID "12345". -Assigns the workspaces with IDs "ws1", "ws2", and "ws3" to the domain with ID "12345". + ```powershell + Add-FabricDomainWorkspaceAssignmentById -DomainId "12345" -WorkspaceIds @("ws1", "ws2", "ws3") + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -22,8 +25,6 @@ Assigns the workspaces with IDs "ws1", "ws2", and "ws3" to the domain with ID "1 Author: Tiago Balabuch #> - -function Add-FabricDomainWorkspaceAssignmentById { [CmdletBinding()] [Alias("Assign-FabricDomainWorkspaceById")] param ( diff --git a/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentByPrincipal.ps1 b/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentByPrincipal.ps1 index 23212274..eb4afd48 100644 --- a/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentByPrincipal.ps1 +++ b/source/Public/Domain/Add-FabricDomainWorkspaceAssignmentByPrincipal.ps1 @@ -1,3 +1,4 @@ +function Add-FabricDomainWorkspaceAssignmentByPrincipal { <# .SYNOPSIS Assigns workspaces to a domain based on principal IDs in Microsoft Fabric. @@ -12,14 +13,16 @@ The ID of the domain to which workspaces will be assigned. This parameter is man An array representing the principals with their `id` and `type` properties. Must contain a `principals` key with an array of objects. .EXAMPLE -$PrincipalIds = @( - @{id = "813abb4a-414c-4ac0-9c2c-bd17036fd58c"; type = "User"}, - @{id = "b5b9495c-685a-447a-b4d3-2d8e963e6288"; type = "User"} - ) + This example assigns workspaces to a domain using a list of principal IDs and types. -Add-FabricDomainWorkspaceAssignmentByPrincipal -DomainId "12345" -PrincipalIds $principals + ```powershell + $PrincipalIds = @( + @{id = "813abb4a-414c-4ac0-9c2c-bd17036fd58c"; type = "User"}, + @{id = "b5b9495c-685a-447a-b4d3-2d8e963e6288"; type = "User"} + ) -Assigns the workspaces based on the provided principal IDs and types. + Add-FabricDomainWorkspaceAssignmentByPrincipal -DomainId "12345" -PrincipalIds $PrincipalIds + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -27,8 +30,6 @@ Assigns the workspaces based on the provided principal IDs and types. Author: Tiago Balabuch #> - -function Add-FabricDomainWorkspaceAssignmentByPrincipal { [CmdletBinding()] [Alias("Assign-FabricDomainWorkspaceByPrincipal")] param ( diff --git a/source/Public/Domain/Add-FabricDomainWorkspaceRoleAssignment.ps1 b/source/Public/Domain/Add-FabricDomainWorkspaceRoleAssignment.ps1 index 9000e127..2528b00d 100644 --- a/source/Public/Domain/Add-FabricDomainWorkspaceRoleAssignment.ps1 +++ b/source/Public/Domain/Add-FabricDomainWorkspaceRoleAssignment.ps1 @@ -1,3 +1,4 @@ +function Add-FabricDomainWorkspaceRoleAssignment { <# .SYNOPSIS Bulk assigns roles to principals for workspaces in a Fabric domain. @@ -19,9 +20,11 @@ An array of principals to assign roles to. Each principal must include: - `type`: The type of the principal (e.g., `User`, `Group`). .EXAMPLE -AssignFabricDomainWorkspaceRoleAssignment -DomainId "12345" -DomainRole "Admins" -PrincipalIds @(@{id="user1"; type="User"}, @{id="group1"; type="Group"}) + Assign the `Admins` role to the specified principals in the domain with ID "12345". -Assigns the `Admins` role to the specified principals in the domain with ID "12345". + ```powershell + Assign-FabricDomainWorkspaceRoleAssignment -DomainId "12345" -DomainRole "Admins" -PrincipalIds @(@{id="user1"; type="User"}, @{id="group1"; type="Group"}) + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -29,8 +32,6 @@ Assigns the `Admins` role to the specified principals in the domain with ID "123 Author: Tiago Balabuch #> - -function Add-FabricDomainWorkspaceRoleAssignment { [CmdletBinding()] [Alias("Assign-FabricDomainWorkspaceRoleAssignment")] param ( diff --git a/source/Public/Domain/Get-FabricDomain.ps1 b/source/Public/Domain/Get-FabricDomain.ps1 index caed9451..d7d9efdd 100644 --- a/source/Public/Domain/Get-FabricDomain.ps1 +++ b/source/Public/Domain/Get-FabricDomain.ps1 @@ -1,3 +1,4 @@ +function Get-FabricDomain { <# .SYNOPSIS Retrieves domain information from Microsoft Fabric, optionally filtering by domain ID, domain name, or only non-empty domains. @@ -15,14 +16,18 @@ The `Get-FabricDomain` function allows retrieval of domains in Microsoft Fabric, (Optional) If set to `$true`, only domains containing workspaces will be returned. .EXAMPLE -Get-FabricDomain -DomainId "12345" + Fetches the domain with ID "12345". -Fetches the domain with ID "12345". + ```powershell + Get-FabricDomain -DomainId "12345" + ``` .EXAMPLE -Get-FabricDomain -DomainName "Finance" + Fetches the domain with the display name "Finance". -Fetches the domain with the display name "Finance". + ```powershell + Get-FabricDomain -DomainName "Finance" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -31,7 +36,6 @@ Fetches the domain with the display name "Finance". Author: Tiago Balabuch #> -function Get-FabricDomain { [CmdletBinding()] [OutputType([System.Object[]])] param ( diff --git a/source/Public/Domain/Get-FabricDomainWorkspace.ps1 b/source/Public/Domain/Get-FabricDomainWorkspace.ps1 index 0b4dd32b..c4e7733f 100644 --- a/source/Public/Domain/Get-FabricDomainWorkspace.ps1 +++ b/source/Public/Domain/Get-FabricDomainWorkspace.ps1 @@ -1,3 +1,4 @@ +function Get-FabricDomainWorkspace { <# .SYNOPSIS Retrieves the workspaces associated with a specific domain in Microsoft Fabric. @@ -9,9 +10,11 @@ The `Get-FabricDomainWorkspace` function fetches the workspaces for the given do The ID of the domain for which to retrieve workspaces. .EXAMPLE -Get-FabricDomainWorkspace -DomainId "12345" + Fetches workspaces for the domain with ID "12345". -Fetches workspaces for the domain with ID "12345". + ```powershell + Get-FabricDomainWorkspace -DomainId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -20,8 +23,6 @@ Fetches workspaces for the domain with ID "12345". Author: Tiago Balabuch #> - -function Get-FabricDomainWorkspace { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Domain/New-FabricDomain.ps1 b/source/Public/Domain/New-FabricDomain.ps1 index b13e7f66..218753a5 100644 --- a/source/Public/Domain/New-FabricDomain.ps1 +++ b/source/Public/Domain/New-FabricDomain.ps1 @@ -1,3 +1,5 @@ +function New-FabricDomain +{ <# .SYNOPSIS Creates a new Fabric domain. @@ -15,9 +17,11 @@ A description of the domain to be created. (Optional) The ID of the parent domain, if applicable. .EXAMPLE -Add-FabricDomain -DomainName "Finance" -DomainDescription "Finance data domain" -ParentDomainId "12345" + Creates a "Finance" domain under the parent domain with ID "12345". -Creates a "Finance" domain under the parent domain with ID "12345". + ```powershell + Add-FabricDomain -DomainName "Finance" -DomainDescription "Finance data domain" -ParentDomainId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -26,9 +30,6 @@ Creates a "Finance" domain under the parent domain with ID "12345". Author: Tiago Balabuch #> - -function New-FabricDomain -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Domain/Remove-FabricDomain.ps1 b/source/Public/Domain/Remove-FabricDomain.ps1 index d14f2a9c..83e9f376 100644 --- a/source/Public/Domain/Remove-FabricDomain.ps1 +++ b/source/Public/Domain/Remove-FabricDomain.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricDomain +{ <# .SYNOPSIS Deletes a Fabric domain by its ID. @@ -9,9 +11,11 @@ The `Remove-FabricDomain` function removes a specified domain from Microsoft Fab The unique identifier of the domain to be deleted. .EXAMPLE -Remove-FabricDomain -DomainId "12345" + Deletes the domain with ID "12345". -Deletes the domain with ID "12345". + ```powershell + Remove-FabricDomain -DomainId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -20,9 +24,6 @@ Deletes the domain with ID "12345". Author: Tiago Balabuch #> - -function Remove-FabricDomain -{ [CmdletBinding(SupportsShouldProcess,ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Domain/Remove-FabricDomainWorkspaceAssignment.ps1 b/source/Public/Domain/Remove-FabricDomainWorkspaceAssignment.ps1 index 34fb2a6a..375ad4f8 100644 --- a/source/Public/Domain/Remove-FabricDomainWorkspaceAssignment.ps1 +++ b/source/Public/Domain/Remove-FabricDomainWorkspaceAssignment.ps1 @@ -1,4 +1,5 @@ - +function Remove-FabricDomainWorkspaceAssignment +{ <# .SYNOPSIS Unassign workspaces from a specified Fabric domain. @@ -14,14 +15,18 @@ The unique identifier of the Fabric domain. (Optional) An array of workspace IDs to unassign. If not provided, all workspaces will be unassigned. .EXAMPLE -Remove-FabricDomainWorkspaceAssignment -DomainId "12345" + Unassigns all workspaces from the domain with ID "12345". -Unassigns all workspaces from the domain with ID "12345". + ```powershell + Remove-FabricDomainWorkspaceAssignment -DomainId "12345" + ``` .EXAMPLE -Remove-FabricDomainWorkspaceAssignment -DomainId "12345" -WorkspaceIds @("workspace1", "workspace2") + Unassigns the specified workspaces from the domain with ID "12345". -Unassigns the specified workspaces from the domain with ID "12345". + ```powershell + Remove-FabricDomainWorkspaceAssignment -DomainId "12345" -WorkspaceIds @("workspace1", "workspace2") + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -31,8 +36,6 @@ Unassigns the specified workspaces from the domain with ID "12345". Author: Tiago Balabuch #> -function Remove-FabricDomainWorkspaceAssignment -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] [Alias("Unassign-FabricDomainWorkspace")] param ( diff --git a/source/Public/Domain/Remove-FabricDomainWorkspaceRoleAssignment.ps1 b/source/Public/Domain/Remove-FabricDomainWorkspaceRoleAssignment.ps1 index a3e3f9b3..ae643341 100644 --- a/source/Public/Domain/Remove-FabricDomainWorkspaceRoleAssignment.ps1 +++ b/source/Public/Domain/Remove-FabricDomainWorkspaceRoleAssignment.ps1 @@ -1,6 +1,7 @@ +function Remove-FabricDomainWorkspaceRoleAssignment { <# .SYNOPSIS -Bulk unUnassign roles to principals for workspaces in a Fabric domain. +Bulk unassign roles to principals for workspaces in a Fabric domain. .DESCRIPTION The `AssignFabricDomainWorkspaceRoleAssignment` function performs bulk role assignments for principals in a specific Fabric domain. It sends a POST request to the relevant API endpoint. @@ -19,9 +20,11 @@ An array of principals to assign roles to. Each principal must include: - `type`: The type of the principal (e.g., `User`, `Group`). .EXAMPLE -AssignFabricDomainWorkspaceRoleAssignment -DomainId "12345" -DomainRole "Admins" -PrincipalIds @(@{id="user1"; type="User"}, @{id="group1"; type="Group"}) + Unassign the `Admins` role to the specified principals in the domain with ID "12345". -Unassign the `Admins` role to the specified principals in the domain with ID "12345". + ```powershell + Unassign-FabricDomainWorkspaceRoleAssignment -DomainId "12345" -DomainRole "Admins" -PrincipalIds @(@{id="user1"; type="User"}, @{id="group1"; type="Group"}) + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -30,8 +33,6 @@ Unassign the `Admins` role to the specified principals in the domain with ID "12 Author: Tiago Balabuch #> - -function Remove-FabricDomainWorkspaceRoleAssignment { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] [Alias("Unassign-FabricDomainWorkspaceRoleAssignment")] param ( diff --git a/source/Public/Domain/Update-FabricDomain.ps1 b/source/Public/Domain/Update-FabricDomain.ps1 index 0ef70281..9f79d1af 100644 --- a/source/Public/Domain/Update-FabricDomain.ps1 +++ b/source/Public/Domain/Update-FabricDomain.ps1 @@ -1,3 +1,5 @@ +function Update-FabricDomain +{ <# .SYNOPSIS Updates a Fabric domain by its ID. @@ -18,9 +20,11 @@ The new name for the domain. Must be alphanumeric. (Optional) The contributors' scope for the domain. Accepted values: 'AdminsOnly', 'AllTenant', 'SpecificUsersAndGroups'. .EXAMPLE -Update-FabricDomain -DomainId "12345" -DomainName "NewDomain" -DomainDescription "Updated description" -DomainContributorsScope "AdminsOnly" + Updates the domain with ID "12345" with a new name, description, and contributors' scope. -Updates the domain with ID "12345" with a new name, description, and contributors' scope. + ```powershell + Update-FabricDomain -DomainId "12345" -DomainName "NewDomain" -DomainDescription "Updated description" -DomainContributorsScope "AdminsOnly" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -29,9 +33,6 @@ Updates the domain with ID "12345" with a new name, description, and contributor Author: Tiago Balabuch #> - -function Update-FabricDomain -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Get-FabricEnvironment.ps1 b/source/Public/Environment/Get-FabricEnvironment.ps1 index a5f6f2a5..c4762b41 100644 --- a/source/Public/Environment/Get-FabricEnvironment.ps1 +++ b/source/Public/Environment/Get-FabricEnvironment.ps1 @@ -1,4 +1,5 @@ function Get-FabricEnvironment { + <# .SYNOPSIS Retrieves an environment or a list of environments from a specified workspace in Microsoft Fabric. @@ -16,14 +17,18 @@ The `Get-FabricEnvironment` function sends a GET request to the Fabric API to re (Optional) The name of the specific environment to retrieve. .EXAMPLE -Get-FabricEnvironment -WorkspaceId "12345" -EnvironmentName "Development" + Retrieves the "Development" environment from workspace "12345". -Retrieves the "Development" environment from workspace "12345". + ```powershell + Get-FabricEnvironment -WorkspaceId "12345" -EnvironmentName "Development" + ``` .EXAMPLE -Get-FabricEnvironment -WorkspaceId "12345" + Retrieves all environments in workspace "12345". -Retrieves all environments in workspace "12345". + ```powershell + Get-FabricEnvironment -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -33,7 +38,6 @@ Retrieves all environments in workspace "12345". Author: Tiago Balabuch #> - [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Get-FabricEnvironmentLibrary.ps1 b/source/Public/Environment/Get-FabricEnvironmentLibrary.ps1 index 41bcdc3d..8f24fdd5 100644 --- a/source/Public/Environment/Get-FabricEnvironmentLibrary.ps1 +++ b/source/Public/Environment/Get-FabricEnvironmentLibrary.ps1 @@ -1,3 +1,4 @@ +function Get-FabricEnvironmentLibrary { <# .SYNOPSIS Retrieves the list of libraries associated with a specific environment in a Microsoft Fabric workspace. @@ -14,9 +15,11 @@ to handle errors gracefully. The unique identifier of the environment whose libraries are being queried. .EXAMPLE -Get-FabricEnvironmentLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + Retrieves the libraries associated with the specified environment in the given workspace. -Retrieves the libraries associated with the specified environment in the given workspace. + ```powershell + Get-FabricEnvironmentLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + ``` .NOTES - Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. @@ -24,7 +27,6 @@ Retrieves the libraries associated with the specified environment in the given w Author: Tiago Balabuch #> -function Get-FabricEnvironmentLibrary { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Get-FabricEnvironmentSparkCompute.ps1 b/source/Public/Environment/Get-FabricEnvironmentSparkCompute.ps1 index 2dd7c2e9..4278710e 100644 --- a/source/Public/Environment/Get-FabricEnvironmentSparkCompute.ps1 +++ b/source/Public/Environment/Get-FabricEnvironmentSparkCompute.ps1 @@ -1,3 +1,4 @@ +function Get-FabricEnvironmentSparkCompute { <# .SYNOPSIS Retrieves the Spark compute details for a specific environment in a Microsoft Fabric workspace. @@ -14,9 +15,11 @@ The unique identifier of the workspace containing the target environment. The unique identifier of the environment whose Spark compute details are being retrieved. .EXAMPLE -Get-FabricEnvironmentSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + Retrieves Spark compute details for the specified environment in the given workspace. -Retrieves Spark compute details for the specified environment in the given workspace. + ```powershell + Get-FabricEnvironmentSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + ``` .NOTES - Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. @@ -24,7 +27,6 @@ Retrieves Spark compute details for the specified environment in the given works Author: Tiago Balabuch #> -function Get-FabricEnvironmentSparkCompute { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Get-FabricEnvironmentStagingLibrary.ps1 b/source/Public/Environment/Get-FabricEnvironmentStagingLibrary.ps1 index cad10cbb..9f2c5ffa 100644 --- a/source/Public/Environment/Get-FabricEnvironmentStagingLibrary.ps1 +++ b/source/Public/Environment/Get-FabricEnvironmentStagingLibrary.ps1 @@ -1,3 +1,4 @@ +function Get-FabricEnvironmentStagingLibrary { <# .SYNOPSIS Retrieves the staging library details for a specific environment in a Microsoft Fabric workspace. @@ -13,9 +14,11 @@ The unique identifier of the workspace containing the target environment. The unique identifier of the environment for which staging library details are being retrieved. .EXAMPLE -Get-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + Retrieves the staging libraries for the specified environment in the given workspace. -Retrieves the staging libraries for the specified environment in the given workspace. + ```powershell + Get-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + ``` .NOTES - Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. @@ -23,7 +26,6 @@ Retrieves the staging libraries for the specified environment in the given works Author: Tiago Balabuch #> -function Get-FabricEnvironmentStagingLibrary { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Get-FabricEnvironmentStagingSparkCompute.ps1 b/source/Public/Environment/Get-FabricEnvironmentStagingSparkCompute.ps1 index 905ee9cf..26ed63f9 100644 --- a/source/Public/Environment/Get-FabricEnvironmentStagingSparkCompute.ps1 +++ b/source/Public/Environment/Get-FabricEnvironmentStagingSparkCompute.ps1 @@ -14,9 +14,11 @@ The unique identifier of the workspace containing the target environment. The unique identifier of the environment for which staging Spark compute details are being retrieved. .EXAMPLE -Get-FabricEnvironmentStagingSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + Retrieves the staging Spark compute configurations for the specified environment in the given workspace. -Retrieves the staging Spark compute configurations for the specified environment in the given workspace. + ```powershell + Get-FabricEnvironmentStagingSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + ``` .NOTES - Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/Environment/Import-FabricEnvironmentStagingLibrary.ps1 b/source/Public/Environment/Import-FabricEnvironmentStagingLibrary.ps1 index e4bfb21f..ef4fc3bd 100644 --- a/source/Public/Environment/Import-FabricEnvironmentStagingLibrary.ps1 +++ b/source/Public/Environment/Import-FabricEnvironmentStagingLibrary.ps1 @@ -1,3 +1,4 @@ +function Import-FabricEnvironmentStagingLibrary { <# .SYNOPSIS Uploads a library to the staging environment in a Microsoft Fabric workspace. @@ -13,7 +14,9 @@ The unique identifier of the workspace where the environment exists. The unique identifier of the environment where the library will be uploaded. .EXAMPLE -Import-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "env-67890" + ```powershell + Import-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "env-67890" + ``` .NOTES - This is not working code. It is a placeholder for future development. Fabric documentation is missing some important details on how to upload libraries. @@ -23,7 +26,6 @@ Import-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -Environme Author: Tiago Balabuch #> -function Import-FabricEnvironmentStagingLibrary { [CmdletBinding()] [Alias("Upload-FabricEnvironmentStagingLibrary")] param ( diff --git a/source/Public/Environment/New-FabricEnvironment.ps1 b/source/Public/Environment/New-FabricEnvironment.ps1 index 60cfa1eb..ab92d075 100644 --- a/source/Public/Environment/New-FabricEnvironment.ps1 +++ b/source/Public/Environment/New-FabricEnvironment.ps1 @@ -1,3 +1,5 @@ +function New-FabricEnvironment +{ <# .SYNOPSIS Creates a new environment in a specified workspace. @@ -15,9 +17,11 @@ The `Add-FabricEnvironment` function creates a new environment within a given wo (Optional) A description of the environment. .EXAMPLE -Add-FabricEnvironment -WorkspaceId "12345" -EnvironmentName "DevEnv" -EnvironmentDescription "Development Environment" + Creates an environment named "DevEnv" in workspace "12345" with the specified description. -Creates an environment named "DevEnv" in workspace "12345" with the specified description. + ```powershell + Add-FabricEnvironment -WorkspaceId "12345" -EnvironmentName "DevEnv" -EnvironmentDescription "Development Environment" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -26,9 +30,6 @@ Creates an environment named "DevEnv" in workspace "12345" with the specified de Author: Tiago Balabuch #> - -function New-FabricEnvironment -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Publish-FabricEnvironment.ps1 b/source/Public/Environment/Publish-FabricEnvironment.ps1 index b9bfec37..1ecedccf 100644 --- a/source/Public/Environment/Publish-FabricEnvironment.ps1 +++ b/source/Public/Environment/Publish-FabricEnvironment.ps1 @@ -1,3 +1,4 @@ +function Publish-FabricEnvironment { <# .SYNOPSIS Publishes a staging environment in a specified Microsoft Fabric workspace. @@ -14,9 +15,11 @@ The unique identifier of the workspace containing the staging environment. The unique identifier of the staging environment to be published. .EXAMPLE -Publish-FabricEnvironment -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + Initiates the publishing process for the specified staging environment. -Initiates the publishing process for the specified staging environment. + ```powershell + Publish-FabricEnvironment -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + ``` .NOTES - Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. @@ -24,8 +27,6 @@ Initiates the publishing process for the specified staging environment. Author: Tiago Balabuch #> - -function Publish-FabricEnvironment { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Remove-FabricEnvironment.ps1 b/source/Public/Environment/Remove-FabricEnvironment.ps1 index 4c188ce0..04d6f762 100644 --- a/source/Public/Environment/Remove-FabricEnvironment.ps1 +++ b/source/Public/Environment/Remove-FabricEnvironment.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricEnvironment +{ <# .SYNOPSIS Deletes an environment from a specified workspace in Microsoft Fabric. @@ -12,9 +14,11 @@ The `Remove-FabricEnvironment` function sends a DELETE request to the Fabric API (Mandatory) The ID of the environment to be deleted. .EXAMPLE -Remove-FabricEnvironment -WorkspaceId "12345" -EnvironmentId "67890" + Deletes the environment with ID "67890" from workspace "12345". -Deletes the environment with ID "67890" from workspace "12345". + ```powershell + Remove-FabricEnvironment -WorkspaceId "12345" -EnvironmentId "67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -23,9 +27,6 @@ Deletes the environment with ID "67890" from workspace "12345". Author: Tiago Balabuch #> - -function Remove-FabricEnvironment -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Remove-FabricEnvironmentStagingLibrary.ps1 b/source/Public/Environment/Remove-FabricEnvironmentStagingLibrary.ps1 index 5cdac850..4847d2d4 100644 --- a/source/Public/Environment/Remove-FabricEnvironmentStagingLibrary.ps1 +++ b/source/Public/Environment/Remove-FabricEnvironmentStagingLibrary.ps1 @@ -18,9 +18,11 @@ The unique identifier of the staging environment containing the library. The name of the library to be deleted from the environment. .EXAMPLE -Remove-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -LibraryName "library-to-delete" + Deletes the specified library from the staging environment in the specified workspace. -Deletes the specified library from the staging environment in the specified workspace. + ```powershell + Remove-FabricEnvironmentStagingLibrary -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" -LibraryName "library-to-delete" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/Environment/Stop-FabricEnvironmentPublish.ps1 b/source/Public/Environment/Stop-FabricEnvironmentPublish.ps1 index 7c196a38..512cdf90 100644 --- a/source/Public/Environment/Stop-FabricEnvironmentPublish.ps1 +++ b/source/Public/Environment/Stop-FabricEnvironmentPublish.ps1 @@ -1,3 +1,5 @@ +function Stop-FabricEnvironmentPublish +{ <# .SYNOPSIS Cancels the publish operation for a specified environment in Microsoft Fabric. @@ -13,9 +15,11 @@ The unique identifier of the workspace where the environment exists. The unique identifier of the environment for which the publish operation is to be canceled. .EXAMPLE -Stop-FabricEnvironmentPublish -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + Cancels the publish operation for the specified environment. -Cancels the publish operation for the specified environment. + ```powershell + Stop-FabricEnvironmentPublish -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -24,8 +28,6 @@ Cancels the publish operation for the specified environment. Author: Tiago Balabuch #> -function Stop-FabricEnvironmentPublish -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Update-FabricEnvironment.ps1 b/source/Public/Environment/Update-FabricEnvironment.ps1 index 9006bbef..873322e4 100644 --- a/source/Public/Environment/Update-FabricEnvironment.ps1 +++ b/source/Public/Environment/Update-FabricEnvironment.ps1 @@ -1,3 +1,5 @@ +function Update-FabricEnvironment +{ <# .SYNOPSIS Updates the properties of a Fabric Environment. @@ -18,14 +20,18 @@ The new name for the Environment. The unique identifier of the workspace where the Environment resides. .EXAMPLE -Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewEnvironmentName" + Updates the name of the Environment with the ID "Environment123" to "NewEnvironmentName". -Updates the name of the Environment with the ID "Environment123" to "NewEnvironmentName". + ```powershell + Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewEnvironmentName" + ``` .EXAMPLE -Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewName" -EnvironmentDescription "Updated description" + Updates both the name and description of the Environment "Environment123". -Updates both the name and description of the Environment "Environment123". + ```powershell + Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewName" -EnvironmentDescription "Updated description" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,9 +40,6 @@ Updates both the name and description of the Environment "Environment123". Author: Tiago Balabuch #> - -function Update-FabricEnvironment -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Environment/Update-FabricEnvironmentStagingSparkCompute.ps1 b/source/Public/Environment/Update-FabricEnvironmentStagingSparkCompute.ps1 index 740796f0..e8b894cc 100644 --- a/source/Public/Environment/Update-FabricEnvironmentStagingSparkCompute.ps1 +++ b/source/Public/Environment/Update-FabricEnvironmentStagingSparkCompute.ps1 @@ -1,3 +1,5 @@ +function Update-FabricEnvironmentStagingSparkCompute +{ <# .SYNOPSIS Updates the Spark compute configuration in the staging environment for a given workspace. @@ -46,7 +48,9 @@ The Spark runtime version to use. A hashtable of additional Spark properties to configure. .EXAMPLE -Update-FabricEnvironmentStagingSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "env-67890" -InstancePoolName "pool1" -InstancePoolType "Workspace" -DriverCores 4 -DriverMemory "16GB" -ExecutorCores 8 -ExecutorMemory "32GB" -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 2 -DynamicExecutorAllocationMaxExecutors 10 -RuntimeVersion "3.1" -SparkProperties @{ "spark.executor.memoryOverhead"="4GB" } + ```powershell + Update-FabricEnvironmentStagingSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "env-67890" -InstancePoolName "pool1" -InstancePoolType "Workspace" -DriverCores 4 -DriverMemory "16GB" -ExecutorCores 8 -ExecutorMemory "32GB" -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 2 -DynamicExecutorAllocationMaxExecutors 10 -RuntimeVersion "3.1" -SparkProperties @{ "spark.executor.memoryOverhead"="4GB" } + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -55,8 +59,6 @@ Update-FabricEnvironmentStagingSparkCompute -WorkspaceId "workspace-12345" -Envi Author: Tiago Balabuch #> -function Update-FabricEnvironmentStagingSparkCompute -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventhouse/Get-FabricEventhouse.ps1 b/source/Public/Eventhouse/Get-FabricEventhouse.ps1 index 1048893e..c18a0b58 100644 --- a/source/Public/Eventhouse/Get-FabricEventhouse.ps1 +++ b/source/Public/Eventhouse/Get-FabricEventhouse.ps1 @@ -20,33 +20,40 @@ function Get-FabricEventhouse { An example of a GUID is '12345678-1234-1234-1234-123456789012'. .EXAMPLE - Get-FabricEventhouse ` - -WorkspaceId '12345678-1234-1234-1234-123456789012' + This example will give you all Eventhouses in the Workspace. - This example will give you all Eventhouses in the Workspace. + ```powershell + Get-FabricEventhouse ` + -WorkspaceId '12345678-1234-1234-1234-123456789012' + ``` .EXAMPLE - Get-FabricEventhouse ` - -WorkspaceId '12345678-1234-1234-1234-123456789012' ` - -EventhouseName 'MyEventhouse' + This example will give you all Information about the Eventhouse with the name 'MyEventhouse'. - This example will give you all Information about the Eventhouse with the name 'MyEventhouse'. + ```powershell + Get-FabricEventhouse ` + -WorkspaceId '12345678-1234-1234-1234-123456789012' ` + -EventhouseName 'MyEventhouse' + ``` .EXAMPLE - Get-FabricEventhouse ` - -WorkspaceId '12345678-1234-1234-1234-123456789012' ` - -EventhouseId '12345678-1234-1234-1234-123456789012' + This example will give you all Information about the Eventhouse with the Id '12345678-1234-1234-1234-123456789012'. - This example will give you all Information about the Eventhouse with the Id '12345678-1234-1234-1234-123456789012'. + ```powershell + Get-FabricEventhouse ` + -WorkspaceId '12345678-1234-1234-1234-123456789012' ` + -EventhouseId '12345678-1234-1234-1234-123456789012' + ``` .EXAMPLE - Get-FabricEventhouse ` - -WorkspaceId '12345678-1234-1234-1234-123456789012' ` - -EventhouseId '12345678-1234-1234-1234-123456789012' ` - -Verbose - - This example will give you all Information about the Eventhouse with the Id '12345678-1234-1234-1234-123456789012'. - It will also give you verbose output which is useful for debugging. + This example will give you all Information about the Eventhouse with the Id '12345678-1234-1234-1234-123456789012'. It will also give you verbose output which is useful for debugging. + + ```powershell + Get-FabricEventhouse ` + -WorkspaceId '12345678-1234-1234-1234-123456789012' ` + -EventhouseId '12345678-1234-1234-1234-123456789012' ` + -Verbose + ``` .LINK https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/list-eventhouses?tabs=HTTP diff --git a/source/Public/Eventhouse/Get-FabricEventhouseDefinition.ps1 b/source/Public/Eventhouse/Get-FabricEventhouseDefinition.ps1 index 0690c447..bd0a18df 100644 --- a/source/Public/Eventhouse/Get-FabricEventhouseDefinition.ps1 +++ b/source/Public/Eventhouse/Get-FabricEventhouseDefinition.ps1 @@ -1,3 +1,4 @@ +function Get-FabricEventhouseDefinition { <# .SYNOPSIS Retrieves the definition of an Eventhouse from a specified Microsoft Fabric workspace. @@ -16,13 +17,19 @@ The format in which to retrieve the Eventhouse definition. This parameter is optional. .EXAMPLE - Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" This example retrieves the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" + ``` + .EXAMPLE - Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhouseFormat "json" This example retrieves the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" in JSON format. + ```powershell + Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhouseFormat "json" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,7 +37,6 @@ Author: Tiago Balabuch #> -function Get-FabricEventhouseDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventhouse/New-FabricEventhouse.ps1 b/source/Public/Eventhouse/New-FabricEventhouse.ps1 index c66d087e..c849aaa0 100644 --- a/source/Public/Eventhouse/New-FabricEventhouse.ps1 +++ b/source/Public/Eventhouse/New-FabricEventhouse.ps1 @@ -1,5 +1,6 @@ function New-FabricEventhouse { + <# .SYNOPSIS Creates a new Eventhouse in a specified Microsoft Fabric workspace. @@ -24,8 +25,11 @@ function New-FabricEventhouse An optional path to the platform-specific definition file to upload. .EXAMPLE - New-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseName "New Eventhouse" -EventhouseDescription "Description of the new Eventhouse" - This example creates a new Eventhouse named "New Eventhouse" in the workspace with ID "workspace-12345" with the provided description. + This example creates a new Eventhouse named "New Eventhouse" in the workspace with ID "workspace-12345" with the provided description. + + ```powershell + New-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseName "New Eventhouse" -EventhouseDescription "Description of the new Eventhouse" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,7 +38,6 @@ function New-FabricEventhouse Author: Tiago Balabuch #> - [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventhouse/Remove-FabricEventhouse.ps1 b/source/Public/Eventhouse/Remove-FabricEventhouse.ps1 index b85ac9e8..1ae781c6 100644 --- a/source/Public/Eventhouse/Remove-FabricEventhouse.ps1 +++ b/source/Public/Eventhouse/Remove-FabricEventhouse.ps1 @@ -1,5 +1,6 @@ function Remove-FabricEventhouse { + <# .SYNOPSIS Removes an Eventhouse from a specified Microsoft Fabric workspace. @@ -18,26 +19,21 @@ function Remove-FabricEventhouse The name of the Eventhouse to delete. EventhouseId and EventhouseName cannot be used together. .EXAMPLE - Remove-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" This example removes the Eventhouse with ID "eventhouse-67890" from the workspace with ID "workspace-12345". -.NOTES - Revsion History: - - - 2024-11-07 - FGE: Implemented SupportShouldProcess - - 2024-11-09 - FGE: Added DisplaName as Alias for EventhouseName - - 2024-11-27 - FGE: Added Verbose Output - -.LINK - https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP + ```powershell + Remove-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" + ``` +.NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. Author: Tiago Balabuch +.LINK + https://learn.microsoft.com/en-us/rest/api/fabric/eventhouse/items/delete-eventhouse?tabs=HTTP #> - [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventhouse/Update-FabricEventhouse.ps1 b/source/Public/Eventhouse/Update-FabricEventhouse.ps1 index 1c356390..90684ed8 100644 --- a/source/Public/Eventhouse/Update-FabricEventhouse.ps1 +++ b/source/Public/Eventhouse/Update-FabricEventhouse.ps1 @@ -1,3 +1,5 @@ +function Update-FabricEventhouse +{ <# .SYNOPSIS Updates an existing Eventhouse in a specified Microsoft Fabric workspace. @@ -19,9 +21,12 @@ An optional new description for the Eventhouse. .EXAMPLE - Update-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhouseName "Updated Eventhouse" -EventhouseDescription "Updated description" This example updates the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" with a new name and description. + ```powershell + Update-FabricEventhouse -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhouseName "Updated Eventhouse" -EventhouseDescription "Updated description" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -29,8 +34,6 @@ Author: Tiago Balabuch #> -function Update-FabricEventhouse -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventhouse/Update-FabricEventhouseDefinition.ps1 b/source/Public/Eventhouse/Update-FabricEventhouseDefinition.ps1 index 9400c97a..815b874b 100644 --- a/source/Public/Eventhouse/Update-FabricEventhouseDefinition.ps1 +++ b/source/Public/Eventhouse/Update-FabricEventhouseDefinition.ps1 @@ -1,3 +1,5 @@ +function Update-FabricEventhouseDefinition +{ <# .SYNOPSIS Updates the definition of an existing Eventhouse in a specified Microsoft Fabric workspace. @@ -19,9 +21,12 @@ An optional path to the platform-specific definition file to upload. .EXAMPLE - Update-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhousePathDefinition "C:\Path\To\EventhouseDefinition.json" This example updates the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" using the provided definition file. + ```powershell + Update-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhousePathDefinition "C:\Path\To\EventhouseDefinition.json" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -29,8 +34,6 @@ Author: Tiago Balabuch #> -function Update-FabricEventhouseDefinition -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventstream/Get-FabricEventstream.ps1 b/source/Public/Eventstream/Get-FabricEventstream.ps1 index bb1a746f..585e5fac 100644 --- a/source/Public/Eventstream/Get-FabricEventstream.ps1 +++ b/source/Public/Eventstream/Get-FabricEventstream.ps1 @@ -1,4 +1,6 @@ function Get-FabricEventstream { + + <# .SYNOPSIS Retrieves an Eventstream or a list of Eventstreams from a specified workspace in Microsoft Fabric. @@ -19,14 +21,18 @@ Retrieves an Eventstream or a list of Eventstreams from a specified workspace in An example of a GUID is '12345678-1234-1234-1234-123456789012'. .EXAMPLE -Get-FabricEventstream -WorkspaceId "12345" -EventstreamName "Development" + Retrieves the "Development" Eventstream from workspace "12345". -Retrieves the "Development" Eventstream from workspace "12345". + ```powershell + Get-FabricEventstream -WorkspaceId "12345" -EventstreamName "Development" + ``` .EXAMPLE -Get-FabricEventstream -WorkspaceId "12345" + Retrieves all Eventstreams in workspace "12345". -Retrieves all Eventstreams in workspace "12345". + ```powershell + Get-FabricEventstream -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -35,8 +41,6 @@ Retrieves all Eventstreams in workspace "12345". Author: Tiago Balabuch #> - - [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventstream/Get-FabricEventstreamDefinition.ps1 b/source/Public/Eventstream/Get-FabricEventstreamDefinition.ps1 index d98bd6cc..585676ad 100644 --- a/source/Public/Eventstream/Get-FabricEventstreamDefinition.ps1 +++ b/source/Public/Eventstream/Get-FabricEventstreamDefinition.ps1 @@ -1,3 +1,4 @@ +function Get-FabricEventstreamDefinition { <# .SYNOPSIS Retrieves the definition of a Eventstream from a specific workspace in Microsoft Fabric. @@ -17,14 +18,18 @@ Specifies the format of the Eventstream definition. Currently, only 'ipynb' is s Default: 'ipynb'. .EXAMPLE -Get-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" + Retrieves the definition of the Eventstream with ID `67890` from the workspace with ID `12345` in the `ipynb` format. -Retrieves the definition of the Eventstream with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" + ``` .EXAMPLE -Get-FabricEventstreamDefinition -WorkspaceId "12345" + Retrieves the definitions of all Eventstreams in the workspace with ID `12345` in the `ipynb` format. -Retrieves the definitions of all Eventstreams in the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricEventstreamDefinition -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,8 +39,6 @@ Retrieves the definitions of all Eventstreams in the workspace with ID `12345` i Author: Tiago Balabuch #> - -function Get-FabricEventstreamDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventstream/New-FabricEventstream.ps1 b/source/Public/Eventstream/New-FabricEventstream.ps1 index bbd33c6f..cbfd36d8 100644 --- a/source/Public/Eventstream/New-FabricEventstream.ps1 +++ b/source/Public/Eventstream/New-FabricEventstream.ps1 @@ -25,8 +25,11 @@ An optional path to the Eventstream definition file (e.g., .ipynb file) to uploa An optional path to the platform-specific definition (e.g., .platform file) to upload. .EXAMPLE -#TODO Fix example name -Add-FabricEventstream -WorkspaceId "workspace-12345" -EventstreamName "New Eventstream" -EventstreamPathDefinition "C:\Eventstreams\example.ipynb" + Creates a new Eventstream named "New Eventstream" in the workspace with ID "workspace-12345". + + ```powershell + New-FabricEventstream -WorkspaceId "workspace-12345" -EventstreamName "New Eventstream" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -35,7 +38,6 @@ Add-FabricEventstream -WorkspaceId "workspace-12345" -EventstreamName "New Event Author: Tiago Balabuch #> - #TODO SupportsShouldProcess [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventstream/Remove-FabricEventstream.ps1 b/source/Public/Eventstream/Remove-FabricEventstream.ps1 index 8250673e..5f0901ed 100644 --- a/source/Public/Eventstream/Remove-FabricEventstream.ps1 +++ b/source/Public/Eventstream/Remove-FabricEventstream.ps1 @@ -19,9 +19,11 @@ The `Remove-FabricEventstream` function sends a DELETE request to the Fabric API The name of the Eventstream to delete. The value for Eventstream is a string. .EXAMPLE -Remove-FabricEventstream -WorkspaceId "12345" -EventstreamId "67890" + Deletes the Eventstream with ID "67890" from workspace "12345". -Deletes the Eventstream with ID "67890" from workspace "12345". + ```powershell + Remove-FabricEventstream -WorkspaceId "12345" -EventstreamId "67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/Eventstream/Update-FabricEventstream.ps1 b/source/Public/Eventstream/Update-FabricEventstream.ps1 index c400c420..6dc9b041 100644 --- a/source/Public/Eventstream/Update-FabricEventstream.ps1 +++ b/source/Public/Eventstream/Update-FabricEventstream.ps1 @@ -1,3 +1,5 @@ +function Update-FabricEventstream +{ <# .SYNOPSIS Updates the properties of a Fabric Eventstream. @@ -18,14 +20,18 @@ The new name for the Eventstream. The unique identifier of the workspace where the Eventstream resides. .EXAMPLE -Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewEventstreamName" + Updates the name of the Eventstream with the ID "Eventstream123" to "NewEventstreamName". -Updates the name of the Eventstream with the ID "Eventstream123" to "NewEventstreamName". + ```powershell + Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewEventstreamName" + ``` .EXAMPLE -Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewName" -EventstreamDescription "Updated description" + Updates both the name and description of the Eventstream "Eventstream123". -Updates both the name and description of the Eventstream "Eventstream123". + ```powershell + Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewName" -EventstreamDescription "Updated description" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,9 +40,6 @@ Updates both the name and description of the Eventstream "Eventstream123". Author: Tiago Balabuch #> - -function Update-FabricEventstream -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Eventstream/Update-FabricEventstreamDefinition.ps1 b/source/Public/Eventstream/Update-FabricEventstreamDefinition.ps1 index b878cc02..79ee66bc 100644 --- a/source/Public/Eventstream/Update-FabricEventstreamDefinition.ps1 +++ b/source/Public/Eventstream/Update-FabricEventstreamDefinition.ps1 @@ -1,3 +1,5 @@ +function Update-FabricEventstreamDefinition +{ <# .SYNOPSIS Updates the definition of a Eventstream in a Microsoft Fabric workspace. @@ -23,14 +25,18 @@ The Eventstream content can be provided as file paths, and metadata updates can Default: `$false`. .EXAMPLE -Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb" + Updates the content of the Eventstream with ID `67890` in the workspace `12345` using the specified Eventstream file. -Updates the content of the Eventstream with ID `67890` in the workspace `12345` using the specified Eventstream file. + ```powershell + Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb" + ``` .EXAMPLE -Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb" -UpdateMetadata $true + Updates both the content and metadata of the Eventstream with ID `67890` in the workspace `12345`. -Updates both the content and metadata of the Eventstream with ID `67890` in the workspace `12345`. + ```powershell + Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb" -UpdateMetadata $true + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -41,9 +47,6 @@ Updates both the content and metadata of the Eventstream with ID `67890` in the Author: Tiago Balabuch #> - -function Update-FabricEventstreamDefinition -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/External Data Share/Get-FabricExternalDataShares.ps1 b/source/Public/External Data Share/Get-FabricExternalDataShares.ps1 index b6c115a1..e8a57a90 100644 --- a/source/Public/External Data Share/Get-FabricExternalDataShares.ps1 +++ b/source/Public/External Data Share/Get-FabricExternalDataShares.ps1 @@ -1,3 +1,4 @@ +function Get-FabricExternalDataShares { <# .SYNOPSIS Retrieves External Data Shares details from a specified Microsoft Fabric. @@ -7,16 +8,18 @@ It handles token validation, constructs the API URL, makes the API request, and processes the response. .EXAMPLE - Get-FabricExternalDataShares This example retrieves the External Data Shares details + ```powershell + Get-FabricExternalDataShares + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. Author: Tiago Balabuch #> -function Get-FabricExternalDataShares { [CmdletBinding()] param ( ) diff --git a/source/Public/External Data Share/Revoke-FabricExternalDataShares.ps1 b/source/Public/External Data Share/Revoke-FabricExternalDataShares.ps1 index 73334de7..678941d5 100644 --- a/source/Public/External Data Share/Revoke-FabricExternalDataShares.ps1 +++ b/source/Public/External Data Share/Revoke-FabricExternalDataShares.ps1 @@ -1,4 +1,5 @@ function Revoke-FabricExternalDataShares { + <# .SYNOPSIS Retrieves External Data Shares details from a specified Microsoft Fabric. @@ -17,16 +18,18 @@ function Revoke-FabricExternalDataShares { The unique identifier of the External Data Share to be retrieved. .EXAMPLE - Get-FabricExternalDataShares This example retrieves the External Data Shares details + ```powershell + Get-FabricExternalDataShares + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. Author: Tiago Balabuch #> - [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Get-FabricAuthToken.ps1 b/source/Public/Get-FabricAuthToken.ps1 index c4632b93..8aa01b25 100644 --- a/source/Public/Get-FabricAuthToken.ps1 +++ b/source/Public/Get-FabricAuthToken.ps1 @@ -1,4 +1,5 @@ -<# +function Get-FabricAuthToken { + <# .SYNOPSIS Retrieves the Fabric API authentication token. @@ -22,8 +23,6 @@ Author: Rui Romano #> - -function Get-FabricAuthToken { [CmdletBinding()] param ( diff --git a/source/Public/Get-FabricDatasetRefreshes.ps1 b/source/Public/Get-FabricDatasetRefreshes.ps1 index 0ccf9af3..e6b30e8c 100644 --- a/source/Public/Get-FabricDatasetRefreshes.ps1 +++ b/source/Public/Get-FabricDatasetRefreshes.ps1 @@ -1,34 +1,36 @@ -<# -.SYNOPSIS - Retrieves the refresh history of a specified dataset in a PowerBI workspace. +function Get-FabricDatasetRefreshes { + <# + .SYNOPSIS + Retrieves the refresh history of a specified dataset in a PowerBI workspace. -.DESCRIPTION - The Get-FabricDatasetRefreshes function uses the PowerBI cmdlets to retrieve the refresh history of a specified dataset in a workspace. It uses the dataset ID and workspace ID to get the dataset and checks if it is refreshable. If it is, the function retrieves the refresh history. + .DESCRIPTION + The Get-FabricDatasetRefreshes function uses the PowerBI cmdlets to retrieve the refresh history of a specified dataset in a workspace. It uses the dataset ID and workspace ID to get the dataset and checks if it is refreshable. If it is, the function retrieves the refresh history. -.PARAMETER DatasetID - The ID of the dataset. This is a mandatory parameter. + .PARAMETER DatasetID + The ID of the dataset. This is a mandatory parameter. -.PARAMETER workspaceId - The ID of the workspace. This is a mandatory parameter. + .PARAMETER workspaceId + The ID of the workspace. This is a mandatory parameter. -.EXAMPLE - Get-FabricDatasetRefreshes -DatasetID "12345678-90ab-cdef-1234-567890abcdef" -workspaceId "abcdef12-3456-7890-abcd-ef1234567890" + .EXAMPLE + This command retrieves the refresh history of the specified dataset in the specified workspace. - This command retrieves the refresh history of the specified dataset in the specified workspace. + ```powershell + Get-FabricDatasetRefreshes -DatasetID "12345678-90ab-cdef-1234-567890abcdef" -workspaceId "abcdef12-3456-7890-abcd-ef1234567890" + ``` -.INPUTS - String. You can pipe two strings that contain the dataset ID and workspace ID to Get-FabricDatasetRefreshes. + .INPUTS + String. You can pipe two strings that contain the dataset ID and workspace ID to Get-FabricDatasetRefreshes. -.OUTPUTS - Object. Get-FabricDatasetRefreshes returns an object that contains the refresh history. + .OUTPUTS + Object. Get-FabricDatasetRefreshes returns an object that contains the refresh history. -.NOTES - Alias: Get-PowerBIDatasetRefreshes, Get-FabDatasetRefreshes + .NOTES + Alias: Get-PowerBIDatasetRefreshes, Get-FabDatasetRefreshes - Author: Ioana Bouariu + Author: Ioana Bouariu -#> -function Get-FabricDatasetRefreshes { + #> # Define aliases for the function for flexibility. [Alias("Get-FabDatasetRefreshes")] diff --git a/source/Public/Invoke-FabricDatasetRefresh.ps1 b/source/Public/Invoke-FabricDatasetRefresh.ps1 index 9c1d4577..b3709c53 100644 --- a/source/Public/Invoke-FabricDatasetRefresh.ps1 +++ b/source/Public/Invoke-FabricDatasetRefresh.ps1 @@ -1,4 +1,5 @@ -<# +function Invoke-FabricDatasetRefresh { + <# .SYNOPSIS This function invokes a refresh of a PowerBI dataset @@ -19,7 +20,6 @@ Author: Ioana Bouariu #> -function Invoke-FabricDatasetRefresh { # Define aliases for the function for flexibility. [Alias("Invoke-FabDatasetRefresh")] diff --git a/source/Public/Item/Export-FabricItem.ps1 b/source/Public/Item/Export-FabricItem.ps1 index 23ae926a..3918b9ed 100644 --- a/source/Public/Item/Export-FabricItem.ps1 +++ b/source/Public/Item/Export-FabricItem.ps1 @@ -1,3 +1,4 @@ +Function Export-FabricItem { <# .SYNOPSIS Exports items from a Fabric workspace. Either all items in a workspace or a specific item. @@ -18,14 +19,18 @@ A script block used to filter the items to be exported. Only items that match th The ID of the specific item to export. If provided, only that item will be exported. .EXAMPLE -Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -path "C:\ExportedItems" + This example exports all items from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory. -This example exports all items from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory. + ```powershell + Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -path "C:\ExportedItems" + ``` .EXAMPLE -Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -itemID "98765432-4321-4321-4321-9876543210BA" -path "C:\ExportedItems" + This example exports the item with the specified ID from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory. -This example exports the item with the specified ID from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory. + ```powershell + Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -itemID "98765432-4321-4321-4321-9876543210BA" -path "C:\ExportedItems" + ``` .NOTES @@ -35,7 +40,6 @@ This function is based on the Export-FabricItems function written by Rui Romano. https://github.com/microsoft/Analysis-Services/tree/master/pbidevmode/fabricps-pbip #> -Function Export-FabricItem { [Alias("Export-FabItem")] [CmdletBinding()] param diff --git a/source/Public/Item/Get-FabricItem.ps1 b/source/Public/Item/Get-FabricItem.ps1 index bcabf58e..2322b0d1 100644 --- a/source/Public/Item/Get-FabricItem.ps1 +++ b/source/Public/Item/Get-FabricItem.ps1 @@ -19,9 +19,11 @@ The ID of the specific item to retrieve. If not specified, all items will be ret (Optional) The type of the fabric items to retrieve. If not specified, all items will be retrieved. .EXAMPLE -Get-FabricItem -workspaceId "12345" -type "file" + This example retrieves all fabric items of type "file" from the workspace with ID "12345". -This example retrieves all fabric items of type "file" from the workspace with ID "12345". + ```powershell + Get-FabricItem -workspaceId "12345" -type "file" + ``` .NOTES diff --git a/source/Public/Item/Import-FabricItem.ps1 b/source/Public/Item/Import-FabricItem.ps1 index 2b017d4d..39e516d3 100644 --- a/source/Public/Item/Import-FabricItem.ps1 +++ b/source/Public/Item/Import-FabricItem.ps1 @@ -1,9 +1,10 @@ -<# +Function Import-FabricItem { + <# .SYNOPSIS Imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. .DESCRIPTION - The Import-FabricItem function imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. It supports multiple aliases for flexibility. + The `Import-FabricItem` function imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. It supports multiple aliases for flexibility. The function handles the import of datasets and reports, ensuring that the correct item type is used and that the items are created or updated as necessary. .PARAMETER fileOverrides @@ -19,24 +20,16 @@ A filter to limit the search for PBIP files to specific folders. .EXAMPLE - Import-FabricItems -path 'C:\PBIPFiles' -workspaceId '12345' -filter 'C:\PBIPFiles\Reports' + This example imports PBIP files from the 'C:\PBIPFiles' folder into the Fabric workspace with ID '12345'. It only searches for PBIP files in the 'C:\PBIPFiles\Reports' folder. - This example imports PBIP files from the 'C:\PBIPFiles' folder into the Fabric workspace with ID '12345'. It only searches for PBIP files in the 'C:\PBIPFiles\Reports' folder. + ```powershell + Import-FabricItem -path 'C:\PBIPFiles' -workspaceId '12345' -filter 'C:\PBIPFiles\Reports' + ``` .NOTES This function requires the Invoke-FabricRestMethod function to be available in the current session. Author: Rui Romano - -#> - -Function Import-FabricItem { - <# - .SYNOPSIS - Imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source. - - .PARAMETER fileOverrides - This parameter let's you override a PBIP file without altering the local file. #> [CmdletBinding(SupportsShouldProcess)] param diff --git a/source/Public/Item/Remove-FabricItem.ps1 b/source/Public/Item/Remove-FabricItem.ps1 index d019bfbe..c39ad612 100644 --- a/source/Public/Item/Remove-FabricItem.ps1 +++ b/source/Public/Item/Remove-FabricItem.ps1 @@ -1,3 +1,4 @@ +Function Remove-FabricItem { <# .SYNOPSIS Removes selected items from a Fabric workspace. @@ -15,12 +16,14 @@ The ID of a specific item to remove. If provided, this item is removed regardless of the filter .EXAMPLE - Remove-FabricItems -WorkspaceID "12345678-90ab-cdef-1234-567890abcdef" -Filter "*test*" + This command removes all items from the workspace with the specified ID whose DisplayName includes "test". .INPUTS String. You can pipe two strings that contain the workspace ID and filter to Remove-FabricItems. - This command removes all items from the workspace with the specified ID whose DisplayName includes "test". + ```powershell + Remove-FabricItem -WorkspaceID "12345678-90ab-cdef-1234-567890abcdef" -Filter "*test*" + ``` .INPUTS - String. You can pipe two strings that contain the workspace ID and filter to Remove-FabricItems. + String. You can pipe a string that contains the workspace ID to Remove-FabricItem. .OUTPUTS None. This function does not return any output. @@ -31,8 +34,6 @@ https://github.com/microsoft/Analysis-Services/tree/master/pbidevmode/fabricps-pbip #> - -Function Remove-FabricItem { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( diff --git a/source/Public/KQL Dashboard/Get-FabricKQLDashboard.ps1 b/source/Public/KQL Dashboard/Get-FabricKQLDashboard.ps1 index 00b2315d..0444ed26 100644 --- a/source/Public/KQL Dashboard/Get-FabricKQLDashboard.ps1 +++ b/source/Public/KQL Dashboard/Get-FabricKQLDashboard.ps1 @@ -1,3 +1,4 @@ +function Get-FabricKQLDashboard { <# .SYNOPSIS Retrieves an KQLDashboard or a list of KQLDashboards from a specified workspace in Microsoft Fabric. @@ -8,22 +9,25 @@ The `Get-FabricKQLDashboard` function sends a GET request to the Fabric API to r .PARAMETER WorkspaceId (Mandatory) The ID of the workspace to query KQLDashboards. +.PARAMETER KQLDashboardId +(Optional) The ID of the specific KQLDashboard to retrieve. + .PARAMETER KQLDashboardName (Optional) The name of the specific KQLDashboard to retrieve. .EXAMPLE -Get-FabricKQLDashboard -WorkspaceId "12345" -KQLDashboardName "Development" - -Retrieves the "Development" KQLDashboard from workspace "12345". + Retrieves the "Development" KQLDashboard from workspace "12345". .PARAMETER KQLDashboardID The Id of the KQLDashboard to retrieve. This parameter cannot be used together with KQLDashboardName. The value for KQLDashboardID is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'. -.PARAMETER KQLDashboardID - The Id of the KQLDashboard to retrieve. This parameter cannot be used together with KQLDashboardName. The value for KQLDashboardID is a GUID. - An example of a GUID is '12345678-1234-1234-1234-123456789012'. + ```powershell + Get-FabricKQLDashboard -WorkspaceId "12345" -KQLDashboardName "Development" + ``` .EXAMPLE -Get-FabricKQLDashboard -WorkspaceId "12345" + Retrieves all KQLDashboards in workspace "12345". -Retrieves all KQLDashboards in workspace "12345". + ```powershell + Get-FabricKQLDashboard -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -32,8 +36,6 @@ Retrieves all KQLDashboards in workspace "12345". Author: Tiago Balabuch #> - -function Get-FabricKQLDashboard { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Dashboard/Get-FabricKQLDashboardDefinition.ps1 b/source/Public/KQL Dashboard/Get-FabricKQLDashboardDefinition.ps1 index 0013a435..2081a4ec 100644 --- a/source/Public/KQL Dashboard/Get-FabricKQLDashboardDefinition.ps1 +++ b/source/Public/KQL Dashboard/Get-FabricKQLDashboardDefinition.ps1 @@ -1,4 +1,4 @@ - +function Get-FabricKQLDashboardDefinition { <# .SYNOPSIS Retrieves the definition of a KQLDashboard from a specific workspace in Microsoft Fabric. @@ -17,14 +17,18 @@ Handles both synchronous and asynchronous operations, with detailed logging and Specifies the format of the KQLDashboard definition. .EXAMPLE -Get-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" + Retrieves the definition of the KQLDashboard with ID `67890` from the workspace with ID `12345` in the `ipynb` format. -Retrieves the definition of the KQLDashboard with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" + ``` .EXAMPLE -Get-FabricKQLDashboardDefinition -WorkspaceId "12345" + Retrieves the definitions of all KQLDashboards in the workspace with ID `12345` in the `ipynb` format. -Retrieves the definitions of all KQLDashboards in the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricKQLDashboardDefinition -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,7 +38,6 @@ Retrieves the definitions of all KQLDashboards in the workspace with ID `12345` Author: Tiago Balabuch #> -function Get-FabricKQLDashboardDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Dashboard/New-FabricKQLDashboard.ps1 b/source/Public/KQL Dashboard/New-FabricKQLDashboard.ps1 index 17e462fa..93f9223d 100644 --- a/source/Public/KQL Dashboard/New-FabricKQLDashboard.ps1 +++ b/source/Public/KQL Dashboard/New-FabricKQLDashboard.ps1 @@ -1,3 +1,5 @@ +function New-FabricKQLDashboard +{ <# .SYNOPSIS Creates a new KQLDashboard in a specified Microsoft Fabric workspace. @@ -23,7 +25,18 @@ An optional path to the KQLDashboard definition file (e.g., .ipynb file) to uplo An optional path to the platform-specific definition (e.g., .platform file) to upload. .EXAMPLE -Add-FabricKQLDashboard -WorkspaceId "workspace-12345" -KQLDashboardName "New KQLDashboard" -KQLDashboardPathDefinition "C:\KQLDashboards\example.ipynb" + Creates a new KQLDashboard named "New KQLDashboard" in the workspace with ID "workspace-12345". + + ```powershell + New-FabricKQLDashboard -WorkspaceId "workspace-12345" -KQLDashboardName "New KQLDashboard" + ``` + +.EXAMPLE + Creates a new KQLDashboard with a definition file and platform definition. + + ```powershell + New-FabricKQLDashboard -WorkspaceId "workspace-12345" -KQLDashboardName "New KQLDashboard" -KQLDashboardPathDefinition "C:\KQLDashboards\example.ipynb" -KQLDashboardPathPlatformDefinition "C:\KQLDashboards\platform.json" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -32,9 +45,6 @@ Add-FabricKQLDashboard -WorkspaceId "workspace-12345" -KQLDashboardName "New KQL Author: Tiago Balabuch #> - -function New-FabricKQLDashboard -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Dashboard/Remove-FabricKQLDashboard.ps1 b/source/Public/KQL Dashboard/Remove-FabricKQLDashboard.ps1 index efad7852..0cf4d460 100644 --- a/source/Public/KQL Dashboard/Remove-FabricKQLDashboard.ps1 +++ b/source/Public/KQL Dashboard/Remove-FabricKQLDashboard.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricKQLDashboard +{ <# .SYNOPSIS Deletes an KQLDashboard from a specified workspace in Microsoft Fabric. @@ -12,9 +14,11 @@ The `Remove-FabricKQLDashboard` function sends a DELETE request to the Fabric AP (Mandatory) The ID of the KQLDashboard to be deleted. .EXAMPLE -Remove-FabricKQLDashboard -WorkspaceId "12345" -KQLDashboardId "67890" + Deletes the KQLDashboard with ID "67890" from workspace "12345". -Deletes the KQLDashboard with ID "67890" from workspace "12345". + ```powershell + Remove-FabricKQLDashboard -WorkspaceId "12345" -KQLDashboardId "67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -23,9 +27,6 @@ Deletes the KQLDashboard with ID "67890" from workspace "12345". Author: Tiago Balabuch #> - -function Remove-FabricKQLDashboard -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]` param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Dashboard/Update-FabricKQLDashboard.ps1 b/source/Public/KQL Dashboard/Update-FabricKQLDashboard.ps1 index 288bd369..5524fd61 100644 --- a/source/Public/KQL Dashboard/Update-FabricKQLDashboard.ps1 +++ b/source/Public/KQL Dashboard/Update-FabricKQLDashboard.ps1 @@ -20,14 +20,18 @@ The new name for the KQLDashboard. The unique identifier of the workspace where the KQLDashboard exists. .EXAMPLE -Update-FabricKQLDashboard -KQLDashboardId "KQLDashboard123" -KQLDashboardName "NewKQLDashboardName" + Updates the name of the KQLDashboard with the ID "KQLDashboard123" to "NewKQLDashboardName". -Updates the name of the KQLDashboard with the ID "KQLDashboard123" to "NewKQLDashboardName". + ```powershell + Update-FabricKQLDashboard -KQLDashboardId "KQLDashboard123" -KQLDashboardName "NewKQLDashboardName" + ``` .EXAMPLE -Update-FabricKQLDashboard -KQLDashboardId "KQLDashboard123" -KQLDashboardName "NewName" -KQLDashboardDescription "Updated description" + Updates both the name and description of the KQLDashboard "KQLDashboard123". -Updates both the name and description of the KQLDashboard "KQLDashboard123". + ```powershell + Update-FabricKQLDashboard -KQLDashboardId "KQLDashboard123" -KQLDashboardName "NewName" -KQLDashboardDescription "Updated description" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/KQL Dashboard/Update-FabricKQLDashboardDefinition.ps1 b/source/Public/KQL Dashboard/Update-FabricKQLDashboardDefinition.ps1 index 7769cf13..57c0064d 100644 --- a/source/Public/KQL Dashboard/Update-FabricKQLDashboardDefinition.ps1 +++ b/source/Public/KQL Dashboard/Update-FabricKQLDashboardDefinition.ps1 @@ -1,3 +1,5 @@ +function Update-FabricKQLDashboardDefinition +{ <# .SYNOPSIS Updates the definition of a KQLDashboard in a Microsoft Fabric workspace. @@ -20,14 +22,18 @@ The KQLDashboard content can be provided as file paths, and metadata updates can .EXAMPLE -Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb" + Updates the content of the KQLDashboard with ID `67890` in the workspace `12345` using the specified KQLDashboard file. -Updates the content of the KQLDashboard with ID `67890` in the workspace `12345` using the specified KQLDashboard file. + ```powershell + Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb" + ``` .EXAMPLE -Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb" + Updates both the content and metadata of the KQLDashboard with ID `67890` in the workspace `12345`. -Updates both the content and metadata of the KQLDashboard with ID `67890` in the workspace `12345`. + ```powershell + Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -38,9 +44,6 @@ Updates both the content and metadata of the KQLDashboard with ID `67890` in the Author: Tiago Balabuch #> - -function Update-FabricKQLDashboardDefinition -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Database/Get-FabricKQLDatabase.ps1 b/source/Public/KQL Database/Get-FabricKQLDatabase.ps1 index 334e8023..d5d8a30c 100644 --- a/source/Public/KQL Database/Get-FabricKQLDatabase.ps1 +++ b/source/Public/KQL Database/Get-FabricKQLDatabase.ps1 @@ -16,14 +16,18 @@ The `Get-FabricKQLDatabase` function sends a GET request to the Fabric API to re (Optional) The name of the specific KQLDatabase to retrieve. .EXAMPLE -Get-FabricKQLDatabase -WorkspaceId "12345" -KQLDatabaseName "Development" + Retrieves the "Development" KQLDatabase from workspace "12345". -Retrieves the "Development" KQLDatabase from workspace "12345". + ```powershell + Get-FabricKQLDatabase -WorkspaceId "12345" -KQLDatabaseName "Development" + ``` .EXAMPLE -Get-FabricKQLDatabase -WorkspaceId "12345" + Retrieves all KQLDatabases in workspace "12345". -Retrieves all KQLDatabases in workspace "12345". + ```powershell + Get-FabricKQLDatabase -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/KQL Database/Get-FabricKQLDatabaseDefinition.ps1 b/source/Public/KQL Database/Get-FabricKQLDatabaseDefinition.ps1 index db061ae4..5828dff7 100644 --- a/source/Public/KQL Database/Get-FabricKQLDatabaseDefinition.ps1 +++ b/source/Public/KQL Database/Get-FabricKQLDatabaseDefinition.ps1 @@ -1,4 +1,4 @@ - +function Get-FabricKQLDatabaseDefinition { <# .SYNOPSIS Retrieves the definition of a KQLDatabase from a specific workspace in Microsoft Fabric. @@ -18,14 +18,18 @@ Handles both synchronous and asynchronous operations, with detailed logging and Specifies the format of the KQLDatabase definition. Currently, only 'ipynb' is supported. .EXAMPLE -Get-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" + Retrieves the definition of the KQLDatabase with ID `67890` from the workspace with ID `12345` in the `ipynb` format. -Retrieves the definition of the KQLDatabase with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" + ``` .EXAMPLE -Get-FabricKQLDatabaseDefinition -WorkspaceId "12345" + Retrieves the definitions of all KQLDatabases in the workspace with ID `12345` in the `ipynb` format. -Retrieves the definitions of all KQLDatabases in the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricKQLDatabaseDefinition -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -35,7 +39,6 @@ Retrieves the definitions of all KQLDatabases in the workspace with ID `12345` i Author: Tiago Balabuch #> -function Get-FabricKQLDatabaseDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Database/New-FabricKQLDatabase.ps1 b/source/Public/KQL Database/New-FabricKQLDatabase.ps1 index a3611370..0326c12e 100644 --- a/source/Public/KQL Database/New-FabricKQLDatabase.ps1 +++ b/source/Public/KQL Database/New-FabricKQLDatabase.ps1 @@ -43,7 +43,11 @@ An optional path to the KQLDatabase definition file (e.g., .ipynb file) to uploa An optional path to the platform-specific definition (e.g., .platform file) to upload. .EXAMPLE -Add-FabricKQLDatabase -WorkspaceId "workspace-12345" -KQLDatabaseName "New KQLDatabase" -KQLDatabasePathDefinition "C:\KQLDatabases\example.ipynb" + Creates a new KQLDatabase named "New KQLDatabase" in the workspace with ID "workspace-12345". + + ```powershell + New-FabricKQLDatabase -WorkspaceId "workspace-12345" -KQLDatabaseName "New KQLDatabase" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/KQL Database/Remove-FabricKQLDatabase.ps1 b/source/Public/KQL Database/Remove-FabricKQLDatabase.ps1 index 105a28a8..17e4c058 100644 --- a/source/Public/KQL Database/Remove-FabricKQLDatabase.ps1 +++ b/source/Public/KQL Database/Remove-FabricKQLDatabase.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricKQLDatabase +{ <# .SYNOPSIS Deletes an KQLDatabase from a specified workspace in Microsoft Fabric. @@ -12,9 +14,11 @@ The `Remove-FabricKQLDatabase` function sends a DELETE request to the Fabric API (Mandatory) The ID of the KQLDatabase to be deleted. .EXAMPLE -Remove-FabricKQLDatabase -WorkspaceId "12345" -KQLDatabaseId "67890" + Deletes the KQLDatabase with ID "67890" from workspace "12345". -Deletes the KQLDatabase with ID "67890" from workspace "12345". + ```powershell + Remove-FabricKQLDatabase -WorkspaceId "12345" -KQLDatabaseId "67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -23,9 +27,6 @@ Deletes the KQLDatabase with ID "67890" from workspace "12345". Author: Tiago Balabuch #> - -function Remove-FabricKQLDatabase -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Database/Update-FabricKQLDatabase.ps1 b/source/Public/KQL Database/Update-FabricKQLDatabase.ps1 index 51573e23..6ad947bd 100644 --- a/source/Public/KQL Database/Update-FabricKQLDatabase.ps1 +++ b/source/Public/KQL Database/Update-FabricKQLDatabase.ps1 @@ -1,3 +1,5 @@ +function Update-FabricKQLDatabase +{ <# .SYNOPSIS Updates the properties of a Fabric KQLDatabase. @@ -18,14 +20,18 @@ The new name for the KQLDatabase. (Optional) The new description for the KQLDatabase. .EXAMPLE -Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewKQLDatabaseName" + Updates the name of the KQLDatabase with the ID "KQLDatabase123" to "NewKQLDatabaseName". -Updates the name of the KQLDatabase with the ID "KQLDatabase123" to "NewKQLDatabaseName". + ```powershell + Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewKQLDatabaseName" + ``` .EXAMPLE -Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewName" -KQLDatabaseDescription "Updated description" + Updates both the name and description of the KQLDatabase "KQLDatabase123". -Updates both the name and description of the KQLDatabase "KQLDatabase123". + ```powershell + Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewName" -KQLDatabaseDescription "Updated description" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,9 +40,6 @@ Updates both the name and description of the KQLDatabase "KQLDatabase123". Author: Tiago Balabuch #> - -function Update-FabricKQLDatabase -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Database/Update-FabricKQLDatabaseDefinition.ps1 b/source/Public/KQL Database/Update-FabricKQLDatabaseDefinition.ps1 index c7d96c20..419b8906 100644 --- a/source/Public/KQL Database/Update-FabricKQLDatabaseDefinition.ps1 +++ b/source/Public/KQL Database/Update-FabricKQLDatabaseDefinition.ps1 @@ -1,3 +1,5 @@ +function Update-FabricKQLDatabaseDefinition +{ <# .SYNOPSIS Updates the definition of a KQLDatabase in a Microsoft Fabric workspace. @@ -26,14 +28,18 @@ Default: `$false`. (Optional) The file path to the KQLDatabase's schema definition file. The content will be encoded as Base64 and sent in the request. .EXAMPLE -Update-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" -KQLDatabasePathDefinition "C:\KQLDatabases\KQLDatabase.ipynb" + Updates the content of the KQLDatabase with ID `67890` in the workspace `12345` using the specified KQLDatabase file. -Updates the content of the KQLDatabase with ID `67890` in the workspace `12345` using the specified KQLDatabase file. + ```powershell + Update-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" -KQLDatabasePathDefinition "C:\KQLDatabases\KQLDatabase.ipynb" + ``` .EXAMPLE -Update-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" -KQLDatabasePathDefinition "C:\KQLDatabases\KQLDatabase.ipynb" -UpdateMetadata $true + Updates both the content and metadata of the KQLDatabase with ID `67890` in the workspace `12345`. -Updates both the content and metadata of the KQLDatabase with ID `67890` in the workspace `12345`. + ```powershell + Update-FabricKQLDatabaseDefinition -WorkspaceId "12345" -KQLDatabaseId "67890" -KQLDatabasePathDefinition "C:\KQLDatabases\KQLDatabase.ipynb" -UpdateMetadata $true + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -44,9 +50,6 @@ Updates both the content and metadata of the KQLDatabase with ID `67890` in the Author: Tiago Balabuch #> - -function Update-FabricKQLDatabaseDefinition -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Queryset/Get-FabricKQLQueryset.ps1 b/source/Public/KQL Queryset/Get-FabricKQLQueryset.ps1 index 89b6bf1a..076380c6 100644 --- a/source/Public/KQL Queryset/Get-FabricKQLQueryset.ps1 +++ b/source/Public/KQL Queryset/Get-FabricKQLQueryset.ps1 @@ -16,14 +16,18 @@ The `Get-FabricKQLQueryset` function sends a GET request to the Fabric API to re (Optional) The name of the specific KQLQueryset to retrieve. .EXAMPLE -Get-FabricKQLQueryset -WorkspaceId "12345" -KQLQuerysetName "Development" + Retrieves the "Development" KQLQueryset from workspace "12345". -Retrieves the "Development" KQLQueryset from workspace "12345". + ```powershell + Get-FabricKQLQueryset -WorkspaceId "12345" -KQLQuerysetName "Development" + ``` .EXAMPLE -Get-FabricKQLQueryset -WorkspaceId "12345" + Retrieves all KQLQuerysets in workspace "12345". -Retrieves all KQLQuerysets in workspace "12345". + ```powershell + Get-FabricKQLQueryset -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/KQL Queryset/Get-FabricKQLQuerysetDefinition.ps1 b/source/Public/KQL Queryset/Get-FabricKQLQuerysetDefinition.ps1 index dafe80d1..f14944e5 100644 --- a/source/Public/KQL Queryset/Get-FabricKQLQuerysetDefinition.ps1 +++ b/source/Public/KQL Queryset/Get-FabricKQLQuerysetDefinition.ps1 @@ -1,4 +1,4 @@ - +function Get-FabricKQLQuerysetDefinition { <# .SYNOPSIS Retrieves the definition of a KQLQueryset from a specific workspace in Microsoft Fabric. @@ -17,14 +17,18 @@ Handles both synchronous and asynchronous operations, with detailed logging and Specifies the format of the KQLQueryset definition. .EXAMPLE -Get-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" + Retrieves the definition of the KQLQueryset with ID `67890` from the workspace with ID `12345` in the `ipynb` format. -Retrieves the definition of the KQLQueryset with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" + ``` .EXAMPLE -Get-FabricKQLQuerysetDefinition -WorkspaceId "12345" + Retrieves the definitions of all KQLQuerysets in the workspace with ID `12345` in the `ipynb` format. -Retrieves the definitions of all KQLQuerysets in the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricKQLQuerysetDefinition -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,7 +38,6 @@ Retrieves the definitions of all KQLQuerysets in the workspace with ID `12345` i Author: Tiago Balabuch #> -function Get-FabricKQLQuerysetDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Queryset/Invoke-FabricKQLCommand.ps1 b/source/Public/KQL Queryset/Invoke-FabricKQLCommand.ps1 index d2555888..59aad054 100644 --- a/source/Public/KQL Queryset/Invoke-FabricKQLCommand.ps1 +++ b/source/Public/KQL Queryset/Invoke-FabricKQLCommand.ps1 @@ -1,4 +1,5 @@ function Invoke-FabricKQLCommand { + <# .SYNOPSIS Executes a KQL command in a Kusto Database. @@ -26,31 +27,23 @@ function Invoke-FabricKQLCommand { a PowerShell object. .EXAMPLE - Invoke-FabricKQLCommand -WorkspaceId '12345678-1234-1234-1234-123456789012' -KQLDatabaseName 'MyKQLDatabase'-KQLCommand '.create table MyTable (MyColumn: string) + This example will create a table named 'MyTable' with a column named 'MyColumn' in the KQLDatabase 'MyKQLDatabase'. - This example will create a table named 'MyTable' with a column named 'MyColumn' in - the KQLDatabase 'MyKQLDatabase'. + ```powershell + Invoke-FabricKQLCommand -WorkspaceId '12345678-1234-1234-1234-123456789012' -KQLDatabaseName 'MyKQLDatabase'-KQLCommand '.create table MyTable (MyColumn: string) + ``` .EXAMPLE - Invoke-FabricKQLCommand ` - -WorkspaceId '2c4ccbb5-9b13-4495-9ab3-ba41152733d9' ` - -KQLDatabaseName 'MyEventhouse2' ` - -KQLCommand 'productcategory - | take 100' + This example will Execute the Query 'productcategory | take 100' in the KQLDatabase 'MyEventhouse2' and it will return the result as an array of PowerShell objects. - This example will Execute the Query 'productcategory | take 100' in the KQLDatabase 'MyEventhouse2' - and it will return the result as an array of PowerShell objects. - -.EXAMPLE + ```powershell Invoke-FabricKQLCommand ` - -WorkspaceId '2c4ccbb5-9b13-4495-9ab3-ba41152733d9' ` - -KQLDatabaseName 'MyEventhouse2' ` - -ReturnRawResult ` - -KQLCommand 'productcategory - | take 100' - - This example will Execute the Query 'productcategory | take 100' in the KQLDatabase 'MyEventhouse2' - and it will return the result as the raw result of the KQL command, which is a JSON object. + -WorkspaceId '2c4ccbb5-9b13-4495-9ab3-ba41152733d9' ` + -KQLDatabaseName 'MyEventhouse2' ` + -ReturnRawResult ` + -KQLCommand 'productcategory + | take 100' + ``` .NOTES Revision History: @@ -61,7 +54,6 @@ function Invoke-FabricKQLCommand { Author: Frank Geisler #> - [CmdletBinding()] param ( diff --git a/source/Public/KQL Queryset/New-FabricKQLQueryset.ps1 b/source/Public/KQL Queryset/New-FabricKQLQueryset.ps1 index 30064b02..695fb9dc 100644 --- a/source/Public/KQL Queryset/New-FabricKQLQueryset.ps1 +++ b/source/Public/KQL Queryset/New-FabricKQLQueryset.ps1 @@ -1,3 +1,4 @@ +function New-FabricKQLQueryset { <# .SYNOPSIS Creates a new KQLQueryset in a specified Microsoft Fabric workspace. @@ -23,7 +24,11 @@ An optional path to the KQLQueryset definition file (e.g., .ipynb file) to uploa An optional path to the platform-specific definition (e.g., .platform file) to upload. .EXAMPLE -Add-FabricKQLQueryset -WorkspaceId "workspace-12345" -KQLQuerysetName "New KQLQueryset" -KQLQuerysetPathDefinition "C:\KQLQuerysets\example.ipynb" + Creates a new KQLQueryset named "New KQLQueryset" in the specified workspace with a path to the definition file. + + ```powershell + New-FabricKQLQueryset -WorkspaceId "workspace-12345" -KQLQuerysetName "New KQLQueryset" -KQLQuerysetPathDefinition "C:\kql\example.ipynb" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -32,8 +37,6 @@ Add-FabricKQLQueryset -WorkspaceId "workspace-12345" -KQLQuerysetName "New KQLQu Author: Tiago Balabuch #> - -function New-FabricKQLQueryset { [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Queryset/Remove-FabricKQLQueryset.ps1 b/source/Public/KQL Queryset/Remove-FabricKQLQueryset.ps1 index 054df6c2..fcf0907c 100644 --- a/source/Public/KQL Queryset/Remove-FabricKQLQueryset.ps1 +++ b/source/Public/KQL Queryset/Remove-FabricKQLQueryset.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricKQLQueryset +{ <# .SYNOPSIS Deletes an KQLQueryset from a specified workspace in Microsoft Fabric. @@ -12,9 +14,11 @@ The `Remove-FabricKQLQueryset` function sends a DELETE request to the Fabric API (Mandatory) The ID of the KQLQueryset to be deleted. .EXAMPLE -Remove-FabricKQLQueryset -WorkspaceId "12345" -KQLQuerysetId "67890" + Deletes the KQLQueryset with ID "67890" from workspace "12345". -Deletes the KQLQueryset with ID "67890" from workspace "12345". + ```powershell + Remove-FabricKQLQueryset -WorkspaceId "12345" -KQLQuerysetId "67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -23,9 +27,6 @@ Deletes the KQLQueryset with ID "67890" from workspace "12345". Author: Tiago Balabuch #> - -function Remove-FabricKQLQueryset -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Queryset/Update-FabricKQLQueryset.ps1 b/source/Public/KQL Queryset/Update-FabricKQLQueryset.ps1 index ae01daee..164745a8 100644 --- a/source/Public/KQL Queryset/Update-FabricKQLQueryset.ps1 +++ b/source/Public/KQL Queryset/Update-FabricKQLQueryset.ps1 @@ -1,3 +1,5 @@ +function Update-FabricKQLQueryset +{ <# .SYNOPSIS Updates the properties of a Fabric KQLQueryset. @@ -18,14 +20,18 @@ The new name for the KQLQueryset. The unique identifier of the workspace where the KQLQueryset exists. .EXAMPLE -Update-FabricKQLQueryset -KQLQuerysetId "KQLQueryset123" -KQLQuerysetName "NewKQLQuerysetName" + Updates the name of the KQLQueryset with the ID "KQLQueryset123" to "NewKQLQuerysetName". -Updates the name of the KQLQueryset with the ID "KQLQueryset123" to "NewKQLQuerysetName". + ```powershell + Update-FabricKQLQueryset -KQLQuerysetId "KQLQueryset123" -KQLQuerysetName "NewKQLQuerysetName" + ``` .EXAMPLE -Update-FabricKQLQueryset -KQLQuerysetId "KQLQueryset123" -KQLQuerysetName "NewName" -KQLQuerysetDescription "Updated description" + Updates both the name and description of the KQLQueryset "KQLQueryset123". -Updates both the name and description of the KQLQueryset "KQLQueryset123". + ```powershell + Update-FabricKQLQueryset -KQLQuerysetId "KQLQueryset123" -KQLQuerysetName "NewName" -KQLQuerysetDescription "Updated description" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,9 +40,6 @@ Updates both the name and description of the KQLQueryset "KQLQueryset123". Author: Tiago Balabuch #> - -function Update-FabricKQLQueryset -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/KQL Queryset/Update-FabricKQLQuerysetDefinition.ps1 b/source/Public/KQL Queryset/Update-FabricKQLQuerysetDefinition.ps1 index 75e8228b..4b06a2df 100644 --- a/source/Public/KQL Queryset/Update-FabricKQLQuerysetDefinition.ps1 +++ b/source/Public/KQL Queryset/Update-FabricKQLQuerysetDefinition.ps1 @@ -1,3 +1,4 @@ +function Update-FabricKQLQuerysetDefinition { <# .SYNOPSIS Updates the definition of a KQLQueryset in a Microsoft Fabric workspace. @@ -19,14 +20,18 @@ The KQLQueryset content can be provided as file paths, and metadata updates can (Optional) The file path to the KQLQueryset's platform-specific definition file. The content will be encoded as Base64 and sent in the request. .EXAMPLE -Update-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" -KQLQuerysetPathDefinition "C:\KQLQuerysets\KQLQueryset.ipynb" + Updates the content of the KQLQueryset with ID `67890` in the workspace `12345` using the specified KQLQueryset file. -Updates the content of the KQLQueryset with ID `67890` in the workspace `12345` using the specified KQLQueryset file. + ```powershell + Update-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" -KQLQuerysetPathDefinition "C:\KQLQuerysets\KQLQueryset.ipynb" + ``` .EXAMPLE -Update-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" -KQLQuerysetPathDefinition "C:\KQLQuerysets\KQLQueryset.ipynb" + Updates both the content and metadata of the KQLQueryset with ID `67890` in the workspace `12345`. -Updates both the content and metadata of the KQLQueryset with ID `67890` in the workspace `12345`. + ```powershell + Update-FabricKQLQuerysetDefinition -WorkspaceId "12345" -KQLQuerysetId "67890" -KQLQuerysetPathDefinition "C:\KQLQuerysets\KQLQueryset.ipynb" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -37,8 +42,6 @@ Updates both the content and metadata of the KQLQueryset with ID `67890` in the Author: Tiago Balabuch #> - -function Update-FabricKQLQuerysetDefinition { [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Lakehouse/Get-FabricLakehouse.ps1 b/source/Public/Lakehouse/Get-FabricLakehouse.ps1 index 76836293..69f04291 100644 --- a/source/Public/Lakehouse/Get-FabricLakehouse.ps1 +++ b/source/Public/Lakehouse/Get-FabricLakehouse.ps1 @@ -16,14 +16,18 @@ The `Get-FabricLakehouse` function sends a GET request to the Fabric API to retr (Optional) The name of the specific Lakehouse to retrieve. .EXAMPLE -Get-FabricLakehouse -WorkspaceId "12345" -LakehouseName "Development" + Retrieves the "Development" Lakehouse from workspace "12345". -Retrieves the "Development" Lakehouse from workspace "12345". + ```powershell + Get-FabricLakehouse -WorkspaceId "12345" -LakehouseName "Development" + ``` .EXAMPLE -Get-FabricLakehouse -WorkspaceId "12345" + Retrieves all Lakehouses in workspace "12345". -Retrieves all Lakehouses in workspace "12345". + ```powershell + Get-FabricLakehouse -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/Lakehouse/Get-FabricLakehouseTable.ps1 b/source/Public/Lakehouse/Get-FabricLakehouseTable.ps1 index dec4e5a2..284ba68c 100644 --- a/source/Public/Lakehouse/Get-FabricLakehouseTable.ps1 +++ b/source/Public/Lakehouse/Get-FabricLakehouseTable.ps1 @@ -1,4 +1,5 @@ function Get-FabricLakehouseTable { + <# .SYNOPSIS Retrieves tables from a specified Lakehouse in a Fabric workspace. @@ -13,15 +14,17 @@ The ID of the workspace containing the Lakehouse. The ID of the Lakehouse from which to retrieve tables. .EXAMPLE -Get-FabricLakehouseTable -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -This example retrieves all tables from the specified Lakehouse in the specified workspace. + This example retrieves all tables from the specified Lakehouse in the specified workspace. + + ```powershell + Get-FabricLakehouseTable -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" + ``` .NOTES Author: Tiago Balabuch #> - [CmdletBinding()] [OutputType([System.Object[]])] param ( diff --git a/source/Public/Lakehouse/New-FabricLakehouse.ps1 b/source/Public/Lakehouse/New-FabricLakehouse.ps1 index 5567852f..ca2b4232 100644 --- a/source/Public/Lakehouse/New-FabricLakehouse.ps1 +++ b/source/Public/Lakehouse/New-FabricLakehouse.ps1 @@ -1,3 +1,5 @@ +function New-FabricLakehouse +{ <# .SYNOPSIS Creates a new Lakehouse in a specified Microsoft Fabric workspace. @@ -20,7 +22,11 @@ An optional description for the Lakehouse. An optional path to enable schemas in the Lakehouse .EXAMPLE -Add-FabricLakehouse -WorkspaceId "workspace-12345" -LakehouseName "New Lakehouse" -LakehouseEnableSchemas $true + Creates a new Lakehouse in the specified workspace with a given name and enable schemas option. + + ```powershell + New-FabricLakehouse -WorkspaceId "workspace-12345" -LakehouseName "New Lakehouse" -LakehouseEnableSchemas $true + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -29,9 +35,6 @@ Add-FabricLakehouse -WorkspaceId "workspace-12345" -LakehouseName "New Lakehouse Author: Tiago Balabuch #> - -function New-FabricLakehouse -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Lakehouse/Remove-FabricLakehouse.ps1 b/source/Public/Lakehouse/Remove-FabricLakehouse.ps1 index 3241a196..69aced7f 100644 --- a/source/Public/Lakehouse/Remove-FabricLakehouse.ps1 +++ b/source/Public/Lakehouse/Remove-FabricLakehouse.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricLakehouse +{ <# .SYNOPSIS Deletes an Lakehouse from a specified workspace in Microsoft Fabric. @@ -12,9 +14,11 @@ The `Remove-FabricLakehouse` function sends a DELETE request to the Fabric API t (Mandatory) The ID of the Lakehouse to be deleted. .EXAMPLE -Remove-FabricLakehouse -WorkspaceId "12345" -LakehouseId "67890" + Deletes the Lakehouse with ID "67890" from workspace "12345". -Deletes the Lakehouse with ID "67890" from workspace "12345". + ```powershell + Remove-FabricLakehouse -WorkspaceId "12345" -LakehouseId "67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -23,9 +27,6 @@ Deletes the Lakehouse with ID "67890" from workspace "12345". Author: Tiago Balabuch #> - -function Remove-FabricLakehouse -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Lakehouse/Start-FabricLakehouseTableMaintenance.ps1 b/source/Public/Lakehouse/Start-FabricLakehouseTableMaintenance.ps1 index cbe130c8..a460ac8d 100644 --- a/source/Public/Lakehouse/Start-FabricLakehouseTableMaintenance.ps1 +++ b/source/Public/Lakehouse/Start-FabricLakehouseTableMaintenance.ps1 @@ -1,5 +1,6 @@ function Start-FabricLakehouseTableMaintenance { + <# .SYNOPSIS Initiates a table maintenance job for a specified Lakehouse in a Fabric workspace. @@ -37,13 +38,19 @@ function Start-FabricLakehouseTableMaintenance A boolean flag indicating whether to wait for the job to complete. Default is false. This parameter is optional. .EXAMPLE - Start-FabricLakehouseTableMaintenance -WorkspaceId "12345" -LakehouseId "67890" -JobType "TableMaintenance" -SchemaName "dbo" -TableName "MyTable" -IsVOrder $true -ColumnsZOrderBy @("Column1", "Column2") -retentionPeriod "7:00:00" -waitForCompletion $true Initiates a table maintenance job for the specified Lakehouse and waits for its completion. + ```powershell + Start-FabricLakehouseTableMaintenance -WorkspaceId "12345" -LakehouseId "67890" -JobType "TableMaintenance" -SchemaName "dbo" -TableName "MyTable" -IsVOrder $true -ColumnsZOrderBy @("Column1", "Column2") -retentionPeriod "7:00:00" -waitForCompletion $true + ``` + .EXAMPLE - Start-FabricLakehouseTableMaintenance -WorkspaceId "12345" -LakehouseId "67890" -JobType "TableMaintenance" -SchemaName "dbo" -TableName "MyTable" -IsVOrder $false -ColumnsZOrderBy @("Column1", "Column2") -retentionPeriod "7:00:00" Initiates a table maintenance job for the specified Lakehouse without waiting for its completion. + ```powershell + Start-FabricLakehouseTableMaintenance -WorkspaceId "12345" -LakehouseId "67890" -JobType "TableMaintenance" -SchemaName "dbo" -TableName "MyTable" -IsVOrder $false -ColumnsZOrderBy @("Column1", "Column2") -retentionPeriod "7:00:00" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -56,7 +63,6 @@ function Start-FabricLakehouseTableMaintenance Author: Tiago Balabuch #> - [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Lakehouse/Update-FabricLakehouse.ps1 b/source/Public/Lakehouse/Update-FabricLakehouse.ps1 index 55a2eb2b..ca45be8d 100644 --- a/source/Public/Lakehouse/Update-FabricLakehouse.ps1 +++ b/source/Public/Lakehouse/Update-FabricLakehouse.ps1 @@ -1,3 +1,5 @@ +function Update-FabricLakehouse +{ <# .SYNOPSIS Updates the properties of a Fabric Lakehouse. @@ -18,14 +20,18 @@ The new name for the Lakehouse. (Optional) The new description for the Lakehouse. .EXAMPLE -Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewLakehouseName" + Updates the name of the Lakehouse with the ID "Lakehouse123" to "NewLakehouseName". -Updates the name of the Lakehouse with the ID "Lakehouse123" to "NewLakehouseName". + ```powershell + Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewLakehouseName" + ``` .EXAMPLE -Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewName" -LakehouseDescription "Updated description" + Updates both the name and description of the Lakehouse "Lakehouse123". -Updates both the name and description of the Lakehouse "Lakehouse123". + ```powershell + Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewName" -LakehouseDescription "Updated description" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,9 +40,6 @@ Updates both the name and description of the Lakehouse "Lakehouse123". Author: Tiago Balabuch #> - -function Update-FabricLakehouse -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Lakehouse/Write-FabricLakehouseTableData.ps1 b/source/Public/Lakehouse/Write-FabricLakehouseTableData.ps1 index a3e8e87b..a7812b71 100644 --- a/source/Public/Lakehouse/Write-FabricLakehouseTableData.ps1 +++ b/source/Public/Lakehouse/Write-FabricLakehouseTableData.ps1 @@ -1,5 +1,6 @@ function Write-FabricLakehouseTableData { + <# .SYNOPSIS @@ -39,19 +40,24 @@ function Write-FabricLakehouseTableData Indicates whether to load data recursively from subfolders (default is false). .EXAMPLE - Import-FabricLakehouseTableData -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -TableName "your-table-name" -PathType "File" -RelativePath "path/to/your/file.csv" -FileFormat "CSV" -CsvDelimiter "," -CsvHeader $true -Mode "append" -Recursive $false This example loads data from a CSV file into the specified table in the Lakehouse. + ```powershell + Import-FabricLakehouseTableData -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -TableName "your-table-name" -PathType "File" -RelativePath "path/to/your/file.csv" -FileFormat "CSV" -CsvDelimiter "," -CsvHeader $true -Mode "append" -Recursive $false + ``` + .EXAMPLE - Import-FabricLakehouseTableData -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -TableName "your-table-name" -PathType "Folder" -RelativePath "path/to/your/folder" -FileFormat "Parquet" -Mode "overwrite" -Recursive $true This example loads data from a folder into the specified table in the Lakehouse, overwriting any existing data. + ```powershell + Import-FabricLakehouseTableData -WorkspaceId "your-workspace-id" -LakehouseId "your-lakehouse-id" -TableName "your-table-name" -PathType "Folder" -RelativePath "path/to/your/folder" -FileFormat "Parquet" -Mode "overwrite" -Recursive $true + ``` + .NOTES Author: Tiago Balabuch #> - [CmdletBinding(SupportsShouldProcess)] [Alias("Import-FabricLakehouseTableData")] param ( diff --git a/source/Public/ML Experiment/Get-FabricMLExperiment.ps1 b/source/Public/ML Experiment/Get-FabricMLExperiment.ps1 index 8a00ead5..0ca1ba70 100644 --- a/source/Public/ML Experiment/Get-FabricMLExperiment.ps1 +++ b/source/Public/ML Experiment/Get-FabricMLExperiment.ps1 @@ -1,3 +1,4 @@ +function Get-FabricMLExperiment { <# .SYNOPSIS Retrieves ML Experiment details from a specified Microsoft Fabric workspace. @@ -16,13 +17,19 @@ The name of the ML Experiment to retrieve. This parameter is optional. .EXAMPLE - Get-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" This example retrieves the ML Experiment details for the experiment with ID "experiment-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" + ``` + .EXAMPLE - Get-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentName "My ML Experiment" This example retrieves the ML Experiment details for the experiment named "My ML Experiment" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentName "My ML Experiment" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,7 +37,6 @@ Author: Tiago Balabuch #> -function Get-FabricMLExperiment { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/ML Experiment/New-FabricMLExperiment.ps1 b/source/Public/ML Experiment/New-FabricMLExperiment.ps1 index 96219a2a..be98671b 100644 --- a/source/Public/ML Experiment/New-FabricMLExperiment.ps1 +++ b/source/Public/ML Experiment/New-FabricMLExperiment.ps1 @@ -1,3 +1,5 @@ +function New-FabricMLExperiment +{ <# .SYNOPSIS Creates a new ML Experiment in a specified Microsoft Fabric workspace. @@ -16,9 +18,12 @@ An optional description for the ML Experiment. .EXAMPLE - New-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentName "New ML Experiment" -MLExperimentDescription "Description of the new ML Experiment" This example creates a new ML Experiment named "New ML Experiment" in the workspace with ID "workspace-12345" with the provided description. + ```powershell + New-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentName "New ML Experiment" -MLExperimentDescription "Description of the new ML Experiment" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -26,8 +31,6 @@ Author: Tiago Balabuch #> -function New-FabricMLExperiment -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/ML Experiment/Remove-FabricMLExperiment.ps1 b/source/Public/ML Experiment/Remove-FabricMLExperiment.ps1 index 18ae66f2..443c07b2 100644 --- a/source/Public/ML Experiment/Remove-FabricMLExperiment.ps1 +++ b/source/Public/ML Experiment/Remove-FabricMLExperiment.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricMLExperiment +{ <# .SYNOPSIS Removes an ML Experiment from a specified Microsoft Fabric workspace. @@ -13,9 +15,12 @@ The unique identifier of the MLExperiment to be removed. .EXAMPLE - Remove-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" This example removes the MLExperiment with ID "experiment-67890" from the workspace with ID "workspace-12345". + ```powershell + Remove-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -23,8 +28,6 @@ Author: Tiago Balabuch #> -function Remove-FabricMLExperiment -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = "High")] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/ML Experiment/Update-FabricMLExperiment.ps1 b/source/Public/ML Experiment/Update-FabricMLExperiment.ps1 index c51e8c9e..9c8d7025 100644 --- a/source/Public/ML Experiment/Update-FabricMLExperiment.ps1 +++ b/source/Public/ML Experiment/Update-FabricMLExperiment.ps1 @@ -1,3 +1,5 @@ +function Update-FabricMLExperiment +{ <# .SYNOPSIS Updates an existing ML Experiment in a specified Microsoft Fabric workspace. @@ -19,9 +21,12 @@ An optional new description for the ML Experiment. .EXAMPLE - Update-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" -MLExperimentName "Updated ML Experiment" -MLExperimentDescription "Updated description" This example updates the ML Experiment with ID "experiment-67890" in the workspace with ID "workspace-12345" with a new name and description. + ```powershell + Update-FabricMLExperiment -WorkspaceId "workspace-12345" -MLExperimentId "experiment-67890" -MLExperimentName "Updated ML Experiment" -MLExperimentDescription "Updated description" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -29,8 +34,6 @@ Author: Tiago Balabuch #> -function Update-FabricMLExperiment -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/ML Model/Get-FabricMLModel.ps1 b/source/Public/ML Model/Get-FabricMLModel.ps1 index 332f8d37..24a1ddf4 100644 --- a/source/Public/ML Model/Get-FabricMLModel.ps1 +++ b/source/Public/ML Model/Get-FabricMLModel.ps1 @@ -1,3 +1,4 @@ +function Get-FabricMLModel { <# .SYNOPSIS Retrieves ML Model details from a specified Microsoft Fabric workspace. @@ -16,13 +17,19 @@ The name of the ML Model to retrieve. This parameter is optional. .EXAMPLE - Get-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" This example retrieves the ML Model details for the model with ID "model-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" + ``` + .EXAMPLE - Get-FabricMLModel -WorkspaceId "workspace-12345" -MLModelName "My ML Model" This example retrieves the ML Model details for the model named "My ML Model" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricMLModel -WorkspaceId "workspace-12345" -MLModelName "My ML Model" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,7 +37,6 @@ Author: Tiago Balabuch #> -function Get-FabricMLModel { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/ML Model/New-FabricMLModel.ps1 b/source/Public/ML Model/New-FabricMLModel.ps1 index 0a6076dd..72b6aced 100644 --- a/source/Public/ML Model/New-FabricMLModel.ps1 +++ b/source/Public/ML Model/New-FabricMLModel.ps1 @@ -1,3 +1,5 @@ +function New-FabricMLModel +{ <# .SYNOPSIS Creates a new ML Model in a specified Microsoft Fabric workspace. @@ -16,9 +18,12 @@ An optional description for the ML Model. .EXAMPLE - New-FabricMLModel -WorkspaceId "workspace-12345" -MLModelName "New ML Model" -MLModelDescription "Description of the new ML Model" This example creates a new ML Model named "New ML Model" in the workspace with ID "workspace-12345" with the provided description. + ```powershell + New-FabricMLModel -WorkspaceId "workspace-12345" -MLModelName "New ML Model" -MLModelDescription "Description of the new ML Model" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -26,8 +31,6 @@ Author: Tiago Balabuch #> -function New-FabricMLModel -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/ML Model/Remove-FabricMLModel.ps1 b/source/Public/ML Model/Remove-FabricMLModel.ps1 index 5d94fb51..41fd3ed5 100644 --- a/source/Public/ML Model/Remove-FabricMLModel.ps1 +++ b/source/Public/ML Model/Remove-FabricMLModel.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricMLModel +{ <# .SYNOPSIS Removes an ML Model from a specified Microsoft Fabric workspace. @@ -13,9 +15,12 @@ The unique identifier of the ML Model to be removed. .EXAMPLE - Remove-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" This example removes the ML Model with ID "model-67890" from the workspace with ID "workspace-12345". + ```powershell + Remove-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -23,8 +28,6 @@ Author: Tiago Balabuch #> -function Remove-FabricMLModel -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/ML Model/Update-FabricMLModel.ps1 b/source/Public/ML Model/Update-FabricMLModel.ps1 index 92532e13..17a88818 100644 --- a/source/Public/ML Model/Update-FabricMLModel.ps1 +++ b/source/Public/ML Model/Update-FabricMLModel.ps1 @@ -1,3 +1,5 @@ +function Update-FabricMLModel +{ <# .SYNOPSIS Updates an existing ML Model in a specified Microsoft Fabric workspace. @@ -16,9 +18,12 @@ New description for the ML Model. .EXAMPLE - Update-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" -MLModelName "Updated ML Model" -MLModelDescription "Updated description" This example updates the ML Model with ID "model-67890" in the workspace with ID "workspace-12345" with a new name and description. + ```powershell + Update-FabricMLModel -WorkspaceId "workspace-12345" -MLModelId "model-67890" -MLModelName "Updated ML Model" -MLModelDescription "Updated description" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -26,8 +31,6 @@ Author: Tiago Balabuch #> -function Update-FabricMLModel -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Mirrored Database/Get-FabricMirroredDatabase.ps1 b/source/Public/Mirrored Database/Get-FabricMirroredDatabase.ps1 index 8a60ed6f..4dd76696 100644 --- a/source/Public/Mirrored Database/Get-FabricMirroredDatabase.ps1 +++ b/source/Public/Mirrored Database/Get-FabricMirroredDatabase.ps1 @@ -16,14 +16,18 @@ The `Get-FabricMirroredDatabase` function sends a GET request to the Fabric API (Optional) The name of the specific MirroredDatabase to retrieve. .EXAMPLE -Get-FabricMirroredDatabase -WorkspaceId "12345" -MirroredDatabaseName "Development" + Retrieves the "Development" MirroredDatabase from workspace "12345". -Retrieves the "Development" MirroredDatabase from workspace "12345". + ```powershell + Get-FabricMirroredDatabase -WorkspaceId "12345" -MirroredDatabaseName "Development" + ``` .EXAMPLE -Get-FabricMirroredDatabase -WorkspaceId "12345" + Retrieves all MirroredDatabases in workspace "12345". -Retrieves all MirroredDatabases in workspace "12345". + ```powershell + Get-FabricMirroredDatabase -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/Mirrored Database/Get-FabricMirroredDatabaseDefinition.ps1 b/source/Public/Mirrored Database/Get-FabricMirroredDatabaseDefinition.ps1 index 9a299d86..09e835da 100644 --- a/source/Public/Mirrored Database/Get-FabricMirroredDatabaseDefinition.ps1 +++ b/source/Public/Mirrored Database/Get-FabricMirroredDatabaseDefinition.ps1 @@ -1,4 +1,4 @@ - +function Get-FabricMirroredDatabaseDefinition { <# .SYNOPSIS Retrieves the definition of a MirroredDatabase from a specific workspace in Microsoft Fabric. @@ -14,14 +14,18 @@ Handles both synchronous and asynchronous operations, with detailed logging and (Optional)The unique identifier of the MirroredDatabase whose definition needs to be retrieved. .EXAMPLE -Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" + Retrieves the definition of the MirroredDatabase with ID `67890` from the workspace with ID `12345`. -Retrieves the definition of the MirroredDatabase with ID `67890` from the workspace with ID `12345`. + ```powershell + Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" + ``` .EXAMPLE -Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345" + Retrieves the definitions of all MirroredDatabases in the workspace with ID `12345`. -Retrieves the definitions of all MirroredDatabases in the workspace with ID `12345`. + ```powershell + Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -31,7 +35,6 @@ Retrieves the definitions of all MirroredDatabases in the workspace with ID `123 Author: Tiago Balabuch #> -function Get-FabricMirroredDatabaseDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Mirrored Database/Get-FabricMirroredDatabaseStatus.ps1 b/source/Public/Mirrored Database/Get-FabricMirroredDatabaseStatus.ps1 index 2051940f..a98d7333 100644 --- a/source/Public/Mirrored Database/Get-FabricMirroredDatabaseStatus.ps1 +++ b/source/Public/Mirrored Database/Get-FabricMirroredDatabaseStatus.ps1 @@ -1,4 +1,5 @@ function Get-FabricMirroredDatabaseStatus { + <# .SYNOPSIS @@ -15,15 +16,17 @@ function Get-FabricMirroredDatabaseStatus { the ID of the mirrored database whose status is to be retrieved. .EXAMPLE - Get-FabricMirroredDatabaseStatus -WorkspaceId "your-workspace-id" -MirroredDatabaseId "your-mirrored-database-id" This example retrieves the status of a mirrored database with the specified ID in the specified workspace. + ```powershell + Get-FabricMirroredDatabaseStatus -WorkspaceId "your-workspace-id" -MirroredDatabaseId "your-mirrored-database-id" + ``` + .NOTES Author: Tiago Balabuch #> - [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Mirrored Database/Get-FabricMirroredDatabaseTableStatus.ps1 b/source/Public/Mirrored Database/Get-FabricMirroredDatabaseTableStatus.ps1 index e9e172e5..b9cd5d8a 100644 --- a/source/Public/Mirrored Database/Get-FabricMirroredDatabaseTableStatus.ps1 +++ b/source/Public/Mirrored Database/Get-FabricMirroredDatabaseTableStatus.ps1 @@ -14,9 +14,12 @@ function Get-FabricMirroredDatabaseTableStatus { The ID of the mirrored database whose table status is to be retrieved. .EXAMPLE - Get-FabricMirroredDatabaseTableStatus -WorkspaceId "your-workspace-id" -MirroredDatabaseId "your-mirrored-database-id" This example retrieves the status of tables in a mirrored database with the specified ID in the specified workspace. + ```powershell + Get-FabricMirroredDatabaseTableStatus -WorkspaceId "your-workspace-id" -MirroredDatabaseId "your-mirrored-database-id" + ``` + .NOTES The function retrieves the PowerBI access token and makes a POST request to the PowerBI API to retrieve the status of tables in the specified mirrored database. It then returns the 'value' property of the response, which contains the table statuses. diff --git a/source/Public/Mirrored Database/New-FabricMirroredDatabase.ps1 b/source/Public/Mirrored Database/New-FabricMirroredDatabase.ps1 index ab0d2725..9e5770ab 100644 --- a/source/Public/Mirrored Database/New-FabricMirroredDatabase.ps1 +++ b/source/Public/Mirrored Database/New-FabricMirroredDatabase.ps1 @@ -1,3 +1,5 @@ +function New-FabricMirroredDatabase +{ <# .SYNOPSIS Creates a new MirroredDatabase in a specified Microsoft Fabric workspace. @@ -23,7 +25,9 @@ An optional path to the MirroredDatabase definition file to upload. An optional path to the platform-specific definition (e.g., .platform file) to upload. .EXAMPLE -Add-FabricMirroredDatabase -WorkspaceId "workspace-12345" -MirroredDatabaseName "New MirroredDatabase" -MirroredDatabasePathDefinition "C:\MirroredDatabases\example.json" + ```powershell + Add-FabricMirroredDatabase -WorkspaceId "workspace-12345" -MirroredDatabaseName "New MirroredDatabase" -MirroredDatabasePathDefinition "C:\MirroredDatabases\example.json" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -32,9 +36,6 @@ Add-FabricMirroredDatabase -WorkspaceId "workspace-12345" -MirroredDatabaseName Author: Tiago Balabuch #> - -function New-FabricMirroredDatabase -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Mirrored Database/Remove-FabricMirroredDatabase.ps1 b/source/Public/Mirrored Database/Remove-FabricMirroredDatabase.ps1 index 0a122d6e..0f8e2221 100644 --- a/source/Public/Mirrored Database/Remove-FabricMirroredDatabase.ps1 +++ b/source/Public/Mirrored Database/Remove-FabricMirroredDatabase.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricMirroredDatabase +{ <# .SYNOPSIS Deletes an MirroredDatabase from a specified workspace in Microsoft Fabric. @@ -12,9 +14,11 @@ The `Remove-FabricMirroredDatabase` function sends a DELETE request to the Fabri (Mandatory) The ID of the MirroredDatabase to be deleted. .EXAMPLE -Remove-FabricMirroredDatabase -WorkspaceId "12345" -MirroredDatabaseId "67890" + Deletes the MirroredDatabase with ID "67890" from workspace "12345". -Deletes the MirroredDatabase with ID "67890" from workspace "12345". + ```powershell + Remove-FabricMirroredDatabase -WorkspaceId "12345" -MirroredDatabaseId "67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -22,9 +26,6 @@ Deletes the MirroredDatabase with ID "67890" from workspace "12345". Author: Tiago Balabuch #> - -function Remove-FabricMirroredDatabase -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Mirrored Database/Start-FabricMirroredDatabaseMirroring.ps1 b/source/Public/Mirrored Database/Start-FabricMirroredDatabaseMirroring.ps1 index afcc9cb9..f0c8efe3 100644 --- a/source/Public/Mirrored Database/Start-FabricMirroredDatabaseMirroring.ps1 +++ b/source/Public/Mirrored Database/Start-FabricMirroredDatabaseMirroring.ps1 @@ -1,5 +1,6 @@ function Start-FabricMirroredDatabaseMirroring { + <# .SYNOPSIS @@ -16,9 +17,12 @@ function Start-FabricMirroredDatabaseMirroring The unique identifier of the mirrored database to be started. This parameter is mandatory. .EXAMPLE - Start-FabricMirroredDatabaseMirroring -WorkspaceId "12345" -MirroredDatabaseId "67890" Starts the mirroring of the mirrored database with ID `67890` in the workspace `12345`. + ```powershell + Start-FabricMirroredDatabaseMirroring -WorkspaceId "12345" -MirroredDatabaseId "67890" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -27,7 +31,6 @@ function Start-FabricMirroredDatabaseMirroring Author: Tiago Balabuch #> - [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Mirrored Database/Stop-FabricMirroredDatabaseMirroring.ps1 b/source/Public/Mirrored Database/Stop-FabricMirroredDatabaseMirroring.ps1 index e29d312d..5af98615 100644 --- a/source/Public/Mirrored Database/Stop-FabricMirroredDatabaseMirroring.ps1 +++ b/source/Public/Mirrored Database/Stop-FabricMirroredDatabaseMirroring.ps1 @@ -19,9 +19,12 @@ function Stop-FabricMirroredDatabaseMirroring .EXAMPLE - Stop-FabricMirroredDatabaseMirroring -WorkspaceId "12345" -MirroredDatabaseId "67890" Stops the mirroring of the mirrored database with ID `67890` in the workspace `12345`. + ```powershell + Stop-FabricMirroredDatabaseMirroring -WorkspaceId "12345" -MirroredDatabaseId "67890" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/Mirrored Database/Update-FabricMirroredDatabase.ps1 b/source/Public/Mirrored Database/Update-FabricMirroredDatabase.ps1 index d5710f29..c96b8746 100644 --- a/source/Public/Mirrored Database/Update-FabricMirroredDatabase.ps1 +++ b/source/Public/Mirrored Database/Update-FabricMirroredDatabase.ps1 @@ -1,3 +1,5 @@ +function Update-FabricMirroredDatabase +{ <# .SYNOPSIS Updates the properties of a Fabric MirroredDatabase. @@ -18,14 +20,18 @@ The new name for the MirroredDatabase. (Optional) The new description for the MirroredDatabase. .EXAMPLE -Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewMirroredDatabaseName" + Updates the name of the MirroredDatabase with the ID "MirroredDatabase123" to "NewMirroredDatabaseName". -Updates the name of the MirroredDatabase with the ID "MirroredDatabase123" to "NewMirroredDatabaseName". + ```powershell + Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewMirroredDatabaseName" + ``` .EXAMPLE -Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewName" -MirroredDatabaseDescription "Updated description" + Updates both the name and description of the MirroredDatabase "MirroredDatabase123". -Updates both the name and description of the MirroredDatabase "MirroredDatabase123". + ```powershell + Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewName" -MirroredDatabaseDescription "Updated description" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,9 +40,6 @@ Updates both the name and description of the MirroredDatabase "MirroredDatabase1 Author: Tiago Balabuch #> - -function Update-FabricMirroredDatabase -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Mirrored Database/Update-FabricMirroredDatabaseDefinition.ps1 b/source/Public/Mirrored Database/Update-FabricMirroredDatabaseDefinition.ps1 index 5f1553ed..28de2b08 100644 --- a/source/Public/Mirrored Database/Update-FabricMirroredDatabaseDefinition.ps1 +++ b/source/Public/Mirrored Database/Update-FabricMirroredDatabaseDefinition.ps1 @@ -1,3 +1,5 @@ +function Update-FabricMirroredDatabaseDefinition +{ <# .SYNOPSIS Updates the definition of a MirroredDatabase in a Microsoft Fabric workspace. @@ -23,14 +25,18 @@ The MirroredDatabase content can be provided as file paths, and metadata updates Default: `$false`. .EXAMPLE -Update-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" -MirroredDatabasePathDefinition "C:\MirroredDatabases\MirroredDatabase.json" + Updates the content of the MirroredDatabase with ID `67890` in the workspace `12345` using the specified MirroredDatabase file. -Updates the content of the MirroredDatabase with ID `67890` in the workspace `12345` using the specified MirroredDatabase file. + ```powershell + Update-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" -MirroredDatabasePathDefinition "C:\MirroredDatabases\MirroredDatabase.json" + ``` .EXAMPLE -Update-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" -MirroredDatabasePathDefinition "C:\MirroredDatabases\MirroredDatabase.json" -UpdateMetadata $true + Updates both the content and metadata of the MirroredDatabase with ID `67890` in the workspace `12345`. -Updates both the content and metadata of the MirroredDatabase with ID `67890` in the workspace `12345`. + ```powershell + Update-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890" -MirroredDatabasePathDefinition "C:\MirroredDatabases\MirroredDatabase.json" -UpdateMetadata $true + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -41,9 +47,6 @@ Updates both the content and metadata of the MirroredDatabase with ID `67890` in Author: Tiago Balabuch #> - -function Update-FabricMirroredDatabaseDefinition -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Mirrored Warehouse/Get-FabricMirroredWarehouse.ps1 b/source/Public/Mirrored Warehouse/Get-FabricMirroredWarehouse.ps1 index 60cdbf43..2b527c88 100644 --- a/source/Public/Mirrored Warehouse/Get-FabricMirroredWarehouse.ps1 +++ b/source/Public/Mirrored Warehouse/Get-FabricMirroredWarehouse.ps1 @@ -16,14 +16,18 @@ The `Get-FabricMirroredWarehouse` function sends a GET request to the Fabric API (Optional) The name of the specific MirroredWarehouse to retrieve. .EXAMPLE -Get-FabricMirroredWarehouse -WorkspaceId "12345" -MirroredWarehouseName "Development" + Retrieves the "Development" MirroredWarehouse from workspace "12345". -Retrieves the "Development" MirroredWarehouse from workspace "12345". + ```powershell + Get-FabricMirroredWarehouse -WorkspaceId "12345" -MirroredWarehouseName "Development" + ``` .EXAMPLE -Get-FabricMirroredWarehouse -WorkspaceId "12345" + Retrieves all MirroredWarehouses in workspace "12345". -Retrieves all MirroredWarehouses in workspace "12345". + ```powershell + Get-FabricMirroredWarehouse -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/Notebook/Get-FabricNotebook.ps1 b/source/Public/Notebook/Get-FabricNotebook.ps1 index 26a222d0..49dd59fd 100644 --- a/source/Public/Notebook/Get-FabricNotebook.ps1 +++ b/source/Public/Notebook/Get-FabricNotebook.ps1 @@ -16,14 +16,18 @@ The `Get-FabricNotebook` function sends a GET request to the Fabric API to retri (Optional) The name of the specific Notebook to retrieve. .EXAMPLE -Get-FabricNotebook -WorkspaceId "12345" -NotebookName "Development" + Retrieves the "Development" Notebook from workspace "12345". -Retrieves the "Development" Notebook from workspace "12345". + ```powershell + Get-FabricNotebook -WorkspaceId "12345" -NotebookName "Development" + ``` .EXAMPLE -Get-FabricNotebook -WorkspaceId "12345" + Retrieves all Notebooks in workspace "12345". -Retrieves all Notebooks in workspace "12345". + ```powershell + Get-FabricNotebook -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/Notebook/Get-FabricNotebookDefinition.ps1 b/source/Public/Notebook/Get-FabricNotebookDefinition.ps1 index 558fc768..b2cb7184 100644 --- a/source/Public/Notebook/Get-FabricNotebookDefinition.ps1 +++ b/source/Public/Notebook/Get-FabricNotebookDefinition.ps1 @@ -1,4 +1,4 @@ - +function Get-FabricNotebookDefinition { <# .SYNOPSIS Retrieves the definition of a notebook from a specific workspace in Microsoft Fabric. @@ -19,14 +19,18 @@ Specifies the format of the notebook definition. Currently, only 'ipynb' is supp Default: 'ipynb'. .EXAMPLE -Get-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" + Retrieves the definition of the notebook with ID `67890` from the workspace with ID `12345` in the `ipynb` format. -Retrieves the definition of the notebook with ID `67890` from the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" + ``` .EXAMPLE -Get-FabricNotebookDefinition -WorkspaceId "12345" + Retrieves the definitions of all notebooks in the workspace with ID `12345` in the `ipynb` format. -Retrieves the definitions of all notebooks in the workspace with ID `12345` in the `ipynb` format. + ```powershell + Get-FabricNotebookDefinition -WorkspaceId "12345" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -36,8 +40,6 @@ Retrieves the definitions of all notebooks in the workspace with ID `12345` in t Author: Tiago Balabuch #> - -function Get-FabricNotebookDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Notebook/New-FabricNotebook.ps1 b/source/Public/Notebook/New-FabricNotebook.ps1 index bb4e0ab7..abb735db 100644 --- a/source/Public/Notebook/New-FabricNotebook.ps1 +++ b/source/Public/Notebook/New-FabricNotebook.ps1 @@ -1,3 +1,5 @@ +function New-FabricNotebook +{ <# .SYNOPSIS Creates a new notebook in a specified Microsoft Fabric workspace. @@ -23,7 +25,11 @@ An optional path to the notebook definition file (e.g., .ipynb file) to upload. An optional path to the platform-specific definition (e.g., .platform file) to upload. .EXAMPLE - Add-FabricNotebook -WorkspaceId "workspace-12345" -NotebookName "New Notebook" -NotebookPathDefinition "C:\notebooks\example.ipynb" + Creates a new notebook in the specified workspace with a given name and path definition. + + ```powershell + New-FabricNotebook -WorkspaceId "workspace-12345" -NotebookName "New Notebook" -NotebookPathDefinition "C:\notebooks\example.ipynb" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -32,9 +38,6 @@ An optional path to the platform-specific definition (e.g., .platform file) to u Author: Tiago Balabuch #> - -function New-FabricNotebook -{ [CmdletBinding(supportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Notebook/New-FabricNotebookNEW.ps1 b/source/Public/Notebook/New-FabricNotebookNEW.ps1 index 5ad75f6d..a5197352 100644 --- a/source/Public/Notebook/New-FabricNotebookNEW.ps1 +++ b/source/Public/Notebook/New-FabricNotebookNEW.ps1 @@ -1,3 +1,5 @@ +function New-FabricNotebookNEW +{ <# .SYNOPSIS Creates a new notebook in a specified Microsoft Fabric workspace. @@ -23,7 +25,9 @@ An optional path to the notebook definition file (e.g., .ipynb file) to upload. An optional path to the platform-specific definition (e.g., .platform file) to upload. .EXAMPLE - Add-FabricNotebook -WorkspaceId "workspace-12345" -NotebookName "New Notebook" -NotebookPathDefinition "C:\notebooks\example.ipynb" + ```powershell + Add-FabricNotebook -WorkspaceId "workspace-12345" -NotebookName "New Notebook" -NotebookPathDefinition "C:\notebooks\example.ipynb" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -32,9 +36,6 @@ An optional path to the platform-specific definition (e.g., .platform file) to u Author: Tiago Balabuch #> - -function New-FabricNotebookNEW -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Notebook/Remove-FabricNotebook.ps1 b/source/Public/Notebook/Remove-FabricNotebook.ps1 index 8c5415fa..c85b4a07 100644 --- a/source/Public/Notebook/Remove-FabricNotebook.ps1 +++ b/source/Public/Notebook/Remove-FabricNotebook.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricNotebook +{ <# .SYNOPSIS Deletes an Notebook from a specified workspace in Microsoft Fabric. @@ -12,9 +14,11 @@ The `Remove-FabricNotebook` function sends a DELETE request to the Fabric API to (Mandatory) The ID of the Notebook to be deleted. .EXAMPLE -Remove-FabricNotebook -WorkspaceId "12345" -NotebookId "67890" + Deletes the Notebook with ID "67890" from workspace "12345". -Deletes the Notebook with ID "67890" from workspace "12345". + ```powershell + Remove-FabricNotebook -WorkspaceId "12345" -NotebookId "67890" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -23,9 +27,6 @@ Deletes the Notebook with ID "67890" from workspace "12345". Author: Tiago Balabuch #> - -function Remove-FabricNotebook -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Notebook/Update-FabricNotebook.ps1 b/source/Public/Notebook/Update-FabricNotebook.ps1 index e0971a47..9a6dfd91 100644 --- a/source/Public/Notebook/Update-FabricNotebook.ps1 +++ b/source/Public/Notebook/Update-FabricNotebook.ps1 @@ -1,3 +1,5 @@ +function Update-FabricNotebook +{ <# .SYNOPSIS Updates the properties of a Fabric Notebook. @@ -18,14 +20,18 @@ The new name for the Notebook. (Optional) The new description for the Notebook. .EXAMPLE -Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewNotebookName" + Updates the name of the Notebook with the ID "Notebook123" to "NewNotebookName". -Updates the name of the Notebook with the ID "Notebook123" to "NewNotebookName". + ```powershell + Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewNotebookName" + ``` .EXAMPLE -Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewName" -NotebookDescription "Updated description" + Updates both the name and description of the Notebook "Notebook123". -Updates both the name and description of the Notebook "Notebook123". + ```powershell + Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewName" -NotebookDescription "Updated description" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -34,9 +40,6 @@ Updates both the name and description of the Notebook "Notebook123". Author: Tiago Balabuch #> - -function Update-FabricNotebook -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Notebook/Update-FabricNotebookDefinition.ps1 b/source/Public/Notebook/Update-FabricNotebookDefinition.ps1 index 15906de8..e741e69c 100644 --- a/source/Public/Notebook/Update-FabricNotebookDefinition.ps1 +++ b/source/Public/Notebook/Update-FabricNotebookDefinition.ps1 @@ -1,3 +1,5 @@ +function Update-FabricNotebookDefinition +{ <# .SYNOPSIS Updates the definition of a notebook in a Microsoft Fabric workspace. @@ -19,14 +21,18 @@ The notebook content can be provided as file paths, and metadata updates can opt (Optional) The file path to the notebook's platform-specific definition file. The content will be encoded as Base64 and sent in the request. .EXAMPLE -Update-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" -NotebookPathDefinition "C:\Notebooks\Notebook.ipynb" + Updates the content of the notebook with ID `67890` in the workspace `12345` using the specified notebook file. -Updates the content of the notebook with ID `67890` in the workspace `12345` using the specified notebook file. + ```powershell + Update-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" -NotebookPathDefinition "C:\Notebooks\Notebook.ipynb" + ``` .EXAMPLE -Update-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" -NotebookPathDefinition "C:\Notebooks\Notebook.ipynb" -NotebookPathPlatformDefinition "C:\Notebooks\.platform" + Updates both the content and metadata of the notebook with ID `67890` in the workspace `12345`. -Updates both the content and metadata of the notebook with ID `67890` in the workspace `12345`. + ```powershell + Update-FabricNotebookDefinition -WorkspaceId "12345" -NotebookId "67890" -NotebookPathDefinition "C:\Notebooks\Notebook.ipynb" -NotebookPathPlatformDefinition "C:\Notebooks\.platform" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. @@ -37,9 +43,6 @@ Updates both the content and metadata of the notebook with ID `67890` in the wor Author: Tiago Balabuch #> - -function Update-FabricNotebookDefinition -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Paginated Reports/Get-FabricPaginatedReport.ps1 b/source/Public/Paginated Reports/Get-FabricPaginatedReport.ps1 index f19ee849..8e1ab41d 100644 --- a/source/Public/Paginated Reports/Get-FabricPaginatedReport.ps1 +++ b/source/Public/Paginated Reports/Get-FabricPaginatedReport.ps1 @@ -1,3 +1,4 @@ +function Get-FabricPaginatedReport { <# .SYNOPSIS Retrieves paginated report details from a specified Microsoft Fabric workspace. @@ -16,13 +17,19 @@ The name of the paginated report to retrieve. This parameter is optional. .EXAMPLE - Get-FabricPaginatedReports -WorkspaceId "workspace-12345" -PaginatedReportId "report-67890" This example retrieves the paginated report details for the report with ID "report-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricPaginatedReports -WorkspaceId "workspace-12345" -PaginatedReportId "report-67890" + ``` + .EXAMPLE - Get-FabricPaginatedReports -WorkspaceId "workspace-12345" -PaginatedReportName "My Paginated Report" This example retrieves the paginated report details for the report named "My Paginated Report" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricPaginatedReports -WorkspaceId "workspace-12345" -PaginatedReportName "My Paginated Report" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,7 +37,6 @@ Author: Tiago Balabuch #> -function Get-FabricPaginatedReport { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Paginated Reports/Update-FabricPaginatedReport.ps1 b/source/Public/Paginated Reports/Update-FabricPaginatedReport.ps1 index 38a3d797..fd20c904 100644 --- a/source/Public/Paginated Reports/Update-FabricPaginatedReport.ps1 +++ b/source/Public/Paginated Reports/Update-FabricPaginatedReport.ps1 @@ -1,3 +1,5 @@ +function Update-FabricPaginatedReport +{ <# .SYNOPSIS Updates an existing paginated report in a specified Microsoft Fabric workspace. @@ -19,9 +21,12 @@ An optional new description for the paginated report. .EXAMPLE - Update-FabricPaginatedReport -WorkspaceId "workspace-12345" -PaginatedReportId "report-67890" -PaginatedReportName "Updated Paginated Report" -PaginatedReportDescription "Updated description" This example updates the paginated report with ID "report-67890" in the workspace with ID "workspace-12345" with a new name and description. + ```powershell + Update-FabricPaginatedReport -WorkspaceId "workspace-12345" -PaginatedReportId "report-67890" -PaginatedReportName "Updated Paginated Report" -PaginatedReportDescription "Updated description" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -29,8 +34,6 @@ Author: Tiago Balabuch #> -function Update-FabricPaginatedReport -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Reflex/Get-FabricReflex.ps1 b/source/Public/Reflex/Get-FabricReflex.ps1 index aa6191ee..5a01928d 100644 --- a/source/Public/Reflex/Get-FabricReflex.ps1 +++ b/source/Public/Reflex/Get-FabricReflex.ps1 @@ -1,3 +1,4 @@ +function Get-FabricReflex { <# .SYNOPSIS Retrieves Reflex details from a specified Microsoft Fabric workspace. @@ -16,13 +17,19 @@ The name of the Reflex to retrieve. This parameter is optional. .EXAMPLE - Get-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" This example retrieves the Reflex details for the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" + ``` + .EXAMPLE - Get-FabricReflex -WorkspaceId "workspace-12345" -ReflexName "My Reflex" This example retrieves the Reflex details for the Reflex named "My Reflex" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricReflex -WorkspaceId "workspace-12345" -ReflexName "My Reflex" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,7 +37,6 @@ Author: Tiago Balabuch #> -function Get-FabricReflex { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Reflex/Get-FabricReflexDefinition.ps1 b/source/Public/Reflex/Get-FabricReflexDefinition.ps1 index 477c0ed2..93f313d6 100644 --- a/source/Public/Reflex/Get-FabricReflexDefinition.ps1 +++ b/source/Public/Reflex/Get-FabricReflexDefinition.ps1 @@ -1,3 +1,4 @@ +function Get-FabricReflexDefinition { <# .SYNOPSIS Retrieves the definition of an Reflex from a specified Microsoft Fabric workspace. @@ -16,13 +17,19 @@ The format in which to retrieve the Reflex definition. This parameter is optional. .EXAMPLE - Get-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" This example retrieves the definition of the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" + ``` + .EXAMPLE - Get-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexFormat "json" This example retrieves the definition of the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345" in JSON format. + ```powershell + Get-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexFormat "json" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,7 +37,6 @@ Author: Tiago Balabuch #> -function Get-FabricReflexDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Reflex/New-FabricReflex.ps1 b/source/Public/Reflex/New-FabricReflex.ps1 index 2ccced6f..b390abc7 100644 --- a/source/Public/Reflex/New-FabricReflex.ps1 +++ b/source/Public/Reflex/New-FabricReflex.ps1 @@ -1,3 +1,5 @@ +function New-FabricReflex +{ <# .SYNOPSIS Creates a new Reflex in a specified Microsoft Fabric workspace. @@ -22,9 +24,12 @@ An optional path to the platform-specific definition file to upload. .EXAMPLE - New-FabricReflex -WorkspaceId "workspace-12345" -ReflexName "New Reflex" -ReflexDescription "Description of the new Reflex" This example creates a new Reflex named "New Reflex" in the workspace with ID "workspace-12345" with the provided description. + ```powershell + New-FabricReflex -WorkspaceId "workspace-12345" -ReflexName "New Reflex" -ReflexDescription "Description of the new Reflex" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -32,8 +37,6 @@ Author: Tiago Balabuch #> -function New-FabricReflex -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Reflex/Remove-FabricReflex.ps1 b/source/Public/Reflex/Remove-FabricReflex.ps1 index 66274ea8..572e24f9 100644 --- a/source/Public/Reflex/Remove-FabricReflex.ps1 +++ b/source/Public/Reflex/Remove-FabricReflex.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricReflex +{ <# .SYNOPSIS Removes an Reflex from a specified Microsoft Fabric workspace. @@ -13,9 +15,12 @@ The unique identifier of the Reflex to be removed. .EXAMPLE - Remove-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" This example removes the Reflex with ID "Reflex-67890" from the workspace with ID "workspace-12345". + ```powershell + Remove-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -23,8 +28,6 @@ Author: Tiago Balabuch #> -function Remove-FabricReflex -{ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Reflex/Update-FabricReflex.ps1 b/source/Public/Reflex/Update-FabricReflex.ps1 index 5d665c84..b10f8927 100644 --- a/source/Public/Reflex/Update-FabricReflex.ps1 +++ b/source/Public/Reflex/Update-FabricReflex.ps1 @@ -1,3 +1,5 @@ +function Update-FabricReflex +{ <# .SYNOPSIS Updates an existing Reflex in a specified Microsoft Fabric workspace. @@ -19,9 +21,12 @@ An optional new description for the Reflex. .EXAMPLE - Update-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexName "Updated Reflex" -ReflexDescription "Updated description" This example updates the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345" with a new name and description. + ```powershell + Update-FabricReflex -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexName "Updated Reflex" -ReflexDescription "Updated description" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -29,8 +34,6 @@ Author: Tiago Balabuch #> -function Update-FabricReflex -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Reflex/Update-FabricReflexDefinition.ps1 b/source/Public/Reflex/Update-FabricReflexDefinition.ps1 index 37b04c31..51a4513c 100644 --- a/source/Public/Reflex/Update-FabricReflexDefinition.ps1 +++ b/source/Public/Reflex/Update-FabricReflexDefinition.ps1 @@ -1,3 +1,5 @@ +function Update-FabricReflexDefinition +{ <# .SYNOPSIS Updates the definition of an existing Reflex in a specified Microsoft Fabric workspace. @@ -19,9 +21,12 @@ An optional path to the platform-specific definition file to upload. .EXAMPLE - Update-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexPathDefinition "C:\Path\To\ReflexDefinition.json" This example updates the definition of the Reflex with ID "Reflex-67890" in the workspace with ID "workspace-12345" using the provided definition file. + ```powershell + Update-FabricReflexDefinition -WorkspaceId "workspace-12345" -ReflexId "Reflex-67890" -ReflexPathDefinition "C:\Path\To\ReflexDefinition.json" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -29,8 +34,6 @@ Author: Tiago Balabuch #> -function Update-FabricReflexDefinition -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Report/Get-FabricReport.ps1 b/source/Public/Report/Get-FabricReport.ps1 index 16792dd2..54151b71 100644 --- a/source/Public/Report/Get-FabricReport.ps1 +++ b/source/Public/Report/Get-FabricReport.ps1 @@ -1,3 +1,4 @@ +function Get-FabricReport { <# .SYNOPSIS Retrieves Report details from a specified Microsoft Fabric workspace. @@ -16,13 +17,19 @@ The name of the Report to retrieve. This parameter is optional. .EXAMPLE - Get-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" This example retrieves the Report details for the Report with ID "Report-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" + ``` + .EXAMPLE - Get-FabricReport -WorkspaceId "workspace-12345" -ReportName "My Report" This example retrieves the Report details for the Report named "My Report" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricReport -WorkspaceId "workspace-12345" -ReportName "My Report" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,7 +37,6 @@ Author: Tiago Balabuch #> -function Get-FabricReport { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Report/Get-FabricReportDefinition.ps1 b/source/Public/Report/Get-FabricReportDefinition.ps1 index f5072b55..8d6d6538 100644 --- a/source/Public/Report/Get-FabricReportDefinition.ps1 +++ b/source/Public/Report/Get-FabricReportDefinition.ps1 @@ -1,3 +1,4 @@ +function Get-FabricReportDefinition { <# .SYNOPSIS Retrieves the definition of an Report from a specified Microsoft Fabric workspace. @@ -16,13 +17,19 @@ The format in which to retrieve the Report definition. This parameter is optional. .EXAMPLE - Get-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" This example retrieves the definition of the Report with ID "Report-67890" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" + ``` + .EXAMPLE - Get-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportFormat "json" This example retrieves the definition of the Report with ID "Report-67890" in the workspace with ID "workspace-12345" in JSON format. + ```powershell + Get-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportFormat "json" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,7 +37,6 @@ Author: Tiago Balabuch #> -function Get-FabricReportDefinition { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Report/New-FabricReport.ps1 b/source/Public/Report/New-FabricReport.ps1 index 6b112e2f..46836432 100644 --- a/source/Public/Report/New-FabricReport.ps1 +++ b/source/Public/Report/New-FabricReport.ps1 @@ -1,3 +1,5 @@ +function New-FabricReport +{ <# .SYNOPSIS Creates a new Report in a specified Microsoft Fabric workspace. @@ -20,9 +22,12 @@ .EXAMPLE - New-FabricReport -WorkspaceId "workspace-12345" -ReportName "New Report" -ReportDescription "Description of the new Report" This example creates a new Report named "New Report" in the workspace with ID "workspace-12345" with the provided description. + ```powershell + New-FabricReport -WorkspaceId "workspace-12345" -ReportName "New Report" -ReportDescription "Description of the new Report" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -30,8 +35,6 @@ Author: Tiago Balabuch #> -function New-FabricReport -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Report/Remove-FabricReport.ps1 b/source/Public/Report/Remove-FabricReport.ps1 index ab2a7ae4..5b179daf 100644 --- a/source/Public/Report/Remove-FabricReport.ps1 +++ b/source/Public/Report/Remove-FabricReport.ps1 @@ -1,3 +1,5 @@ +function Remove-FabricReport +{ <# .SYNOPSIS Removes an Report from a specified Microsoft Fabric workspace. @@ -13,9 +15,12 @@ The unique identifier of the Report to be removed. .EXAMPLE - Remove-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" This example removes the Report with ID "Report-67890" from the workspace with ID "workspace-12345". + ```powershell + Remove-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -23,8 +28,6 @@ Author: Tiago Balabuch #> -function Remove-FabricReport -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Report/Update-FabricReport.ps1 b/source/Public/Report/Update-FabricReport.ps1 index 4f637235..77e4b47c 100644 --- a/source/Public/Report/Update-FabricReport.ps1 +++ b/source/Public/Report/Update-FabricReport.ps1 @@ -1,3 +1,5 @@ +function Update-FabricReport +{ <# .SYNOPSIS Updates an existing Report in a specified Microsoft Fabric workspace. @@ -19,9 +21,12 @@ An optional new description for the Report. .EXAMPLE - Update-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportName "Updated Report" -ReportDescription "Updated description" This example updates the Report with ID "Report-67890" in the workspace with ID "workspace-12345" with a new name and description. + ```powershell + Update-FabricReport -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportName "Updated Report" -ReportDescription "Updated description" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -29,8 +34,6 @@ Author: Tiago Balabuch #> -function Update-FabricReport -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Report/Update-FabricReportDefinition.ps1 b/source/Public/Report/Update-FabricReportDefinition.ps1 index eb6ed915..7f3b51df 100644 --- a/source/Public/Report/Update-FabricReportDefinition.ps1 +++ b/source/Public/Report/Update-FabricReportDefinition.ps1 @@ -1,3 +1,5 @@ +function Update-FabricReportDefinition +{ <# .SYNOPSIS Updates the definition of an existing Report in a specified Microsoft Fabric workspace. @@ -16,9 +18,12 @@ A mandatory path to the Report definition file to upload. .EXAMPLE - Update-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportPathDefinition "C:\Path\To\ReportDefinition.json" This example updates the definition of the Report with ID "Report-67890" in the workspace with ID "workspace-12345" using the provided definition file. + ```powershell + Update-FabricReportDefinition -WorkspaceId "workspace-12345" -ReportId "Report-67890" -ReportPathDefinition "C:\Path\To\ReportDefinition.json" + ``` + .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Confirm-TokenState` to ensure token validity before making the API request. @@ -26,8 +31,6 @@ Author: Tiago Balabuch #> -function Update-FabricReportDefinition -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Restore Points/Get-FabricRecoveryPoint.ps1 b/source/Public/Restore Points/Get-FabricRecoveryPoint.ps1 index c492b84b..f52c99fb 100644 --- a/source/Public/Restore Points/Get-FabricRecoveryPoint.ps1 +++ b/source/Public/Restore Points/Get-FabricRecoveryPoint.ps1 @@ -1,41 +1,42 @@ -<# -.SYNOPSIS -Get a list of Fabric recovery points. - -.DESCRIPTION -Get a list of Fabric recovery points. Results can be filter by date or type. +function Get-FabricRecoveryPoint { + <# + .SYNOPSIS + Get a list of Fabric recovery points. -.PARAMETER BaseUrl -Defaults to api.powerbi.com + .DESCRIPTION + Get a list of Fabric recovery points. Results can be filter by date or type. -.PARAMETER WorkspaceGUID -This is the workspace GUID in which the data warehouse resides. + .PARAMETER BaseUrl + Defaults to api.powerbi.com -.PARAMETER DataWarehouseGUID -The GUID for the data warehouse which we want to retrieve restore points for. + .PARAMETER WorkspaceGUID + This is the workspace GUID in which the data warehouse resides. -.PARAMETER Since -Filter the results to only include restore points created after this date. + .PARAMETER DataWarehouseGUID + The GUID for the data warehouse which we want to retrieve restore points for. -.PARAMETER Type -Filter the results to only include restore points of this type. + .PARAMETER Since + Filter the results to only include restore points created after this date. -.PARAMETER CreateTime -The specific unique time of the restore point to remove. Get this from Get-FabricRecoveryPoint. + .PARAMETER Type + Filter the results to only include restore points of this type. -.EXAMPLE -PS> Get-FabricRecoveryPoint -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' + .PARAMETER CreateTime + The specific unique time of the restore point to remove. Get this from Get-FabricRecoveryPoint. -Gets all the available recovery points for the specified data warehouse, in the specified workspace. + .EXAMPLE + Gets all the available recovery points for the specified data warehouse, in the specified workspace. -.NOTES -Based on API calls from this blog post: https://blog.fabric.microsoft.com/en-US/blog/the-art-of-data-warehouse-recovery-within-microsoft-fabric/ + ```powershell + Get-FabricRecoveryPoint -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' + ``` -Author: Jess Pomfret + .NOTES + Based on API calls from this blog post: https://blog.fabric.microsoft.com/en-US/blog/the-art-of-data-warehouse-recovery-within-microsoft-fabric/ -#> + Author: Jess Pomfret -function Get-FabricRecoveryPoint { + #> param ( [guid]$WorkspaceGUID, diff --git a/source/Public/Restore Points/New-FabricRecoveryPoint.ps1 b/source/Public/Restore Points/New-FabricRecoveryPoint.ps1 index d6a62ed4..de111a9c 100644 --- a/source/Public/Restore Points/New-FabricRecoveryPoint.ps1 +++ b/source/Public/Restore Points/New-FabricRecoveryPoint.ps1 @@ -1,3 +1,4 @@ +function New-FabricRecoveryPoint { <# .SYNOPSIS Create a recovery point for a Fabric data warehouse @@ -20,18 +21,16 @@ PS> New-FabricRecoveryPoint Create a new recovery point for the data warehouse specified in the configuration. .EXAMPLE -PS> New-FabricRecoveryPoint -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' - -Create a new recovery point for the specified data warehouse, in the specified workspace. - + Create a new recovery point for the specified data warehouse, in the specified workspace. + ```powershell + New-FabricRecoveryPoint -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' + ``` .NOTES Author: Jess Pomfret #> - -function New-FabricRecoveryPoint { [CmdletBinding(SupportsShouldProcess)] param ( [guid]$WorkspaceGUID, diff --git a/source/Public/Restore Points/Remove-FabricRecoveryPoint.ps1 b/source/Public/Restore Points/Remove-FabricRecoveryPoint.ps1 index 94223bf5..8f9f7a95 100644 --- a/source/Public/Restore Points/Remove-FabricRecoveryPoint.ps1 +++ b/source/Public/Restore Points/Remove-FabricRecoveryPoint.ps1 @@ -1,3 +1,4 @@ +function Remove-FabricRecoveryPoint { <# .SYNOPSIS Remove a selected Fabric Recovery Point. @@ -18,22 +19,24 @@ This is the workspace GUID in which the data warehouse resides. The GUID for the data warehouse which we want to retrieve restore points for. .EXAMPLE -PS> Remove-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' + Remove a specific restore point from a Fabric Data Warehouse that has been set using Set-FabricConfig. -Remove a specific restore point from a Fabric Data Warehouse that has been set using Set-FabricConfig. + ```powershell + Remove-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' + ``` .EXAMPLE -PS> Remove-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' + Remove a specific restore point from a Fabric Data Warehouse, specifying the workspace and data warehouse GUIDs. -Remove a specific restore point from a Fabric Data Warehouse, specifying the workspace and data warehouse GUIDs. + ```powershell + Remove-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' + ``` .NOTES Author: Jess Pomfret #> - -function Remove-FabricRecoveryPoint { [CmdletBinding(SupportsShouldProcess)] param ( [string]$CreateTime, diff --git a/source/Public/Restore Points/Restore-FabricRecoveryPoint.ps1 b/source/Public/Restore Points/Restore-FabricRecoveryPoint.ps1 index 6e7cc2e3..f54450e8 100644 --- a/source/Public/Restore Points/Restore-FabricRecoveryPoint.ps1 +++ b/source/Public/Restore Points/Restore-FabricRecoveryPoint.ps1 @@ -1,3 +1,4 @@ +function Restore-FabricRecoveryPoint { <# .SYNOPSIS Restore a Fabric data warehouse to a specified restore pont. @@ -21,22 +22,24 @@ The GUID for the data warehouse which we want to retrieve restore points for. Wait for the restore to complete before returning. .EXAMPLE -PS> Restore-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' + Restore a Fabric Data Warehouse to a specific restore point that has been set using Set-FabricConfig. -Restore a Fabric Data Warehouse to a specific restore point that has been set using Set-FabricConfig. + ```powershell + Restore-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' + ``` .EXAMPLE -PS> Restore-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' + Restore a Fabric Data Warehouse to a specific restore point, specifying the workspace and data warehouse GUIDs. -Restore a Fabric Data Warehouse to a specific restore point, specifying the workspace and data warehouse GUIDs. + ```powershell + Restore-FabricRecoveryPoint -CreateTime '2024-07-23T11:20:26Z' -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' + ``` .NOTES Author: Jess Pomfret #> - -function Restore-FabricRecoveryPoint { [CmdletBinding(SupportsShouldProcess)] param ( [string]$CreateTime, diff --git a/source/Public/SQL Database/Get-FabricSQLDatabase.ps1 b/source/Public/SQL Database/Get-FabricSQLDatabase.ps1 index 516302fc..6840d956 100644 --- a/source/Public/SQL Database/Get-FabricSQLDatabase.ps1 +++ b/source/Public/SQL Database/Get-FabricSQLDatabase.ps1 @@ -1,64 +1,65 @@ function Get-FabricSQLDatabase { - <# -.SYNOPSIS - Retrieves Fabric SQL Database details. + .SYNOPSIS + Retrieves Fabric SQL Database details. -.DESCRIPTION - Retrieves Fabric SQL Database details. Without the SQLDatabaseName or SQLDatabaseID parameter, - all SQL Databases are returned. If you want to retrieve a specific SQLDatabase, you can - use the SQLDatabaseName or SQLDatabaseID parameter. These parameters cannot be used together. + .DESCRIPTION + Retrieves Fabric SQL Database details. Without the SQLDatabaseName or SQLDatabaseID parameter, + all SQL Databases are returned. If you want to retrieve a specific SQLDatabase, you can + use the SQLDatabaseName or SQLDatabaseID parameter. These parameters cannot be used together. -.PARAMETER WorkspaceId - Id of the Fabric Workspace for which the SQL Databases should be retrieved. The value for WorkspaceId is a GUID. - An example of a GUID is '12345678-1234-1234-1234-123456789012'. + .PARAMETER WorkspaceId + Id of the Fabric Workspace for which the SQL Databases should be retrieved. The value for WorkspaceId is a GUID. + An example of a GUID is '12345678-1234-1234-1234-123456789012'. -.PARAMETER Workspace - The workspace object. This is a mandatory parameter for the 'WorkspaceObject' parameter set and can be pipelined into the function. - The object can be easily retrieved by Get-FabricWorkspace function. + .PARAMETER Workspace + The workspace object. This is a mandatory parameter for the 'WorkspaceObject' parameter set and can be pipelined into the function. + The object can be easily retrieved by Get-FabricWorkspace function. -.PARAMETER SQLDatabaseName - The name of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseID. + .PARAMETER SQLDatabaseName + The name of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseID. -.PARAMETER SQLDatabaseID - The Id of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseName. - The value for SQLDatabaseID is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'. + .PARAMETER SQLDatabaseID + The Id of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseName. + The value for SQLDatabaseID is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'. -.EXAMPLE - $FabricSQLDatabaseConfig = @{ - WorkspaceId = '12345678-1234-1234-1234-123456789012' - SQLDatabaseName = 'MySQLDatabase' - } - Get-FabricSQLDatabase @FabricSQLDatabaseConfig + .EXAMPLE + Returns the details of the Fabric SQL Database with the name 'MySQLDatabase' in the workspace that is specified by the WorkspaceId. - Returns the details of the Fabric SQL Database with the name 'MySQLDatabase' in the workspace that is specified by the WorkspaceId. + ```powershell + $FabricSQLDatabaseConfig = @{ + WorkspaceId = '12345678-1234-1234-1234-123456789012' + SQLDatabaseName = 'MySQLDatabase' + } + Get-FabricSQLDatabase @FabricSQLDatabaseConfig + ``` -.EXAMPLE - Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012' + .EXAMPLE + Returns the details of the Fabric SQL Databases in the workspace that is specified by the WorkspaceId. - Returns the details of the Fabric SQL Databases in the workspace that is specified by the WorkspaceId. + ```powershell + Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012' + ``` -.EXAMPLE - $FabricSQLDatabaseConfig = @{ - WorkspaceId = '12345678-1234-1234-1234-123456789012' - -SQLDatabaseId = '12345678-1234-1234-1234-123456789012' - } - Get-FabricSQLDatabase @FabricSQLDatabaseConfig + .EXAMPLE + Returns the details of the Fabric SQL Database with the ID '12345678-1234-1234-1234-123456789012' from the workspace with the ID '12345678-1234-1234-1234-123456789012'. - Returns the details of the Fabric SQL Database with the ID '12345678-1234-1234-1234-123456789012' from the workspace with the ID '12345678-1234-1234-1234-123456789012'. + ```powershell + Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012' -SQLDatabaseId '12345678-1234-1234-1234-123456789012' + ``` -.EXAMPLE - Get-FabricWorkspace -WorkspaceName 'MsLearn-dev' | Get-FabricSQLDatabase + .EXAMPLE + Returns the details of the Fabric SQL Databases in the MsLearn-dev workspace. - Returns the details of the Fabric SQL Databases in the MsLearn-dev workspace. + ```powershell + Get-FabricWorkspace -WorkspaceName 'MsLearn-dev' | Get-FabricSQLDatabase + ``` -.NOTES - Author: Kamil Nowinski + .NOTES + Author: Kamil Nowinski #> - - [CmdletBinding()] param ( [Parameter(Mandatory = $true, ParameterSetName = 'WorkspaceId')] diff --git a/source/Public/SQL Database/New-FabricSQLDatabase.ps1 b/source/Public/SQL Database/New-FabricSQLDatabase.ps1 index 9af6e9b3..8e0df170 100644 --- a/source/Public/SQL Database/New-FabricSQLDatabase.ps1 +++ b/source/Public/SQL Database/New-FabricSQLDatabase.ps1 @@ -1,36 +1,36 @@ -<# -.SYNOPSIS - Creates a new SQL Database in a specified Microsoft Fabric workspace. - -.DESCRIPTION - This function sends a POST request to the Microsoft Fabric API to create a new SQL Database - in the specified workspace. It supports optional parameters for SQL Database description - and path definitions for the SQL Database content. - -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SQL Database will be created. +function New-FabricSQLDatabase +{ + <# + .SYNOPSIS + Creates a new SQL Database in a specified Microsoft Fabric workspace. -.PARAMETER Name - The name of the SQL Database to be created. + .DESCRIPTION + The `New-FabricSQLDatabase` function sends a POST request to the Microsoft Fabric API to create a new SQL Database + in the specified workspace. It supports optional parameters for SQL Database description + and path definitions for the SQL Database content. -.PARAMETER Description - An optional description for the SQL Database. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SQL Database will be created. -.PARAMETER NoWait - If specified, the function will not wait for the operation to complete and will return immediately. + .PARAMETER Name + The name of the SQL Database to be created. -.EXAMPLE - New-FabricSQLDatabase -WorkspaceId "workspace-12345" -Name "NewDatabase" + .PARAMETER Description + An optional description for the SQL Database. -.NOTES -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + .PARAMETER NoWait + If specified, the function will not wait for the operation to complete and will return immediately. -Author: Kamil Nowinski + .EXAMPLE + ```powershell + New-FabricSQLDatabase -WorkspaceId "workspace-12345" -Name "NewDatabase" + ``` + .NOTES + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> + Author: Kamil Nowinski -function New-FabricSQLDatabase -{ + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/SQL Database/Remove-FabricSQLDatabase.ps1 b/source/Public/SQL Database/Remove-FabricSQLDatabase.ps1 index 2456c347..067df9a9 100644 --- a/source/Public/SQL Database/Remove-FabricSQLDatabase.ps1 +++ b/source/Public/SQL Database/Remove-FabricSQLDatabase.ps1 @@ -1,30 +1,30 @@ -<# -.SYNOPSIS -Deletes a SQL Database from a specified workspace in Microsoft Fabric. - -.DESCRIPTION -The `Remove-FabricSQLDatabase` function sends a DELETE request to the Fabric API to remove a specified SQLDatabase from a given workspace. - -.PARAMETER WorkspaceId -(Mandatory) The ID of the workspace containing the SQLDatabase to delete. +function Remove-FabricSQLDatabase +{ + <# + .SYNOPSIS + Deletes a SQL Database from a specified workspace in Microsoft Fabric. -.PARAMETER SQLDatabaseId -(Mandatory) The ID of the SQL Database to be deleted. + .DESCRIPTION + The `Remove-FabricSQLDatabase` function sends a DELETE request to the Fabric API to remove a specified SQLDatabase from a given workspace. -.EXAMPLE -Remove-FabricSQLDatabas -WorkspaceId "12345" -SQLDatabaseId "67890" + .PARAMETER WorkspaceId + (Mandatory) The ID of the workspace containing the SQLDatabase to delete. -Deletes the SQL Database with ID "67890" from workspace "12345". + .PARAMETER SQLDatabaseId + (Mandatory) The ID of the SQL Database to be deleted. -.NOTES -- Validates token expiration before making the API request. + .EXAMPLE + Deletes the SQL Database with ID "67890" from workspace "12345". -Author: Kamil Nowinski + ```powershell + Remove-FabricSQLDatabas -WorkspaceId "12345" -SQLDatabaseId "67890" + ``` -#> + .NOTES + - Validates token expiration before making the API request. -function Remove-FabricSQLDatabase -{ + Author: Kamil Nowinski + #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/SQL Endpoints/Get-FabricSQLEndpoint.ps1 b/source/Public/SQL Endpoints/Get-FabricSQLEndpoint.ps1 index 61bececb..9559611a 100644 --- a/source/Public/SQL Endpoints/Get-FabricSQLEndpoint.ps1 +++ b/source/Public/SQL Endpoints/Get-FabricSQLEndpoint.ps1 @@ -1,37 +1,40 @@ -<# -.SYNOPSIS -Retrieves SQL Endpoints from a specified workspace in Fabric. - -.DESCRIPTION -The Get-FabricSQLEndpoint function retrieves SQL Endpoints from a specified workspace in Fabric. -It supports filtering by SQL Endpoint ID or SQL Endpoint Name. If both filters are provided, -an error message is returned. The function handles token validation, API requests with continuation -tokens, and processes the response to return the desired SQL Endpoint(s). +function Get-FabricSQLEndpoint { + <# + .SYNOPSIS + Retrieves SQL Endpoints from a specified workspace in Fabric. -.PARAMETER WorkspaceId -The ID of the workspace from which to retrieve SQL Endpoints. This parameter is mandatory. + .DESCRIPTION + The `Get-FabricSQLEndpoint` function retrieves SQL Endpoints from a specified workspace in Fabric. + It supports filtering by SQL Endpoint ID or SQL Endpoint Name. If both filters are provided, + an error message is returned. The function handles token validation, API requests with continuation + tokens, and processes the response to return the desired SQL Endpoint(s). -.PARAMETER SQLEndpointId -The ID of the SQL Endpoint to retrieve. This parameter is optional but cannot be used together with SQLEndpointName. + .PARAMETER WorkspaceId + The ID of the workspace from which to retrieve SQL Endpoints. This parameter is mandatory. -.PARAMETER SQLEndpointName -The name of the SQL Endpoint to retrieve. This parameter is optional but cannot be used together with SQLEndpointId. + .PARAMETER SQLEndpointId + The ID of the SQL Endpoint to retrieve. This parameter is optional but cannot be used together with SQLEndpointName. -.EXAMPLE -Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointId "endpoint456" + .PARAMETER SQLEndpointName + The name of the SQL Endpoint to retrieve. This parameter is optional but cannot be used together with SQLEndpointId. -.EXAMPLE -Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointName "MySQLEndpoint" + .EXAMPLE + ```powershell + Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointId "endpoint456" + ``` -.NOTES -- This function requires the FabricConfig object to be properly configured with BaseUrl and FabricHeaders. -- The function uses continuation tokens to handle paginated API responses. -- If no filter parameters are provided, all SQL Endpoints in the specified workspace are returned. + .EXAMPLE + ```powershell + Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointName "MySQLEndpoint" + ``` -Author: Tiago Balabuch + .NOTES + - This function requires the FabricConfig object to be properly configured with BaseUrl and FabricHeaders. + - The function uses continuation tokens to handle paginated API responses. + - If no filter parameters are provided, all SQL Endpoints in the specified workspace are returned. + Author: Tiago Balabuch #> -function Get-FabricSQLEndpoint { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Semantic Model/Get-FabricSemanticModel.ps1 b/source/Public/Semantic Model/Get-FabricSemanticModel.ps1 index dc26ad98..9f0c0d1d 100644 --- a/source/Public/Semantic Model/Get-FabricSemanticModel.ps1 +++ b/source/Public/Semantic Model/Get-FabricSemanticModel.ps1 @@ -1,36 +1,41 @@ -<# -.SYNOPSIS - Retrieves SemanticModel details from a specified Microsoft Fabric workspace. +function Get-FabricSemanticModel { + <# + .SYNOPSIS + Retrieves SemanticModel details from a specified Microsoft Fabric workspace. -.DESCRIPTION - This function retrieves SemanticModel details from a specified workspace using either the provided SemanticModelId or SemanticModelName. - It handles token validation, constructs the API URL, makes the API request, and processes the response. + .DESCRIPTION + This function retrieves SemanticModel details from a specified workspace using either the provided SemanticModelId or SemanticModelName. + It handles token validation, constructs the API URL, makes the API request, and processes the response. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SemanticModel exists. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SemanticModel exists. This parameter is mandatory. -.PARAMETER SemanticModelId - The unique identifier of the SemanticModel to retrieve. This parameter is optional. + .PARAMETER SemanticModelId + The unique identifier of the SemanticModel to retrieve. This parameter is optional. -.PARAMETER SemanticModelName - The name of the SemanticModel to retrieve. This parameter is optional. + .PARAMETER SemanticModelName + The name of the SemanticModel to retrieve. This parameter is optional. -.EXAMPLE - Get-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" - This example retrieves the SemanticModel details for the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345". + .EXAMPLE + This example retrieves the SemanticModel details for the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345". -.EXAMPLE - Get-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelName "My SemanticModel" - This example retrieves the SemanticModel details for the SemanticModel named "My SemanticModel" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" + ``` -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + This example retrieves the SemanticModel details for the SemanticModel named "My SemanticModel" in the workspace with ID "workspace-12345". - Author: Tiago Balabuch + ```powershell + Get-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelName "My SemanticModel" + ``` -#> -function Get-FabricSemanticModel { + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Semantic Model/Get-FabricSemanticModelDefinition.ps1 b/source/Public/Semantic Model/Get-FabricSemanticModelDefinition.ps1 index 881c8209..30051ec4 100644 --- a/source/Public/Semantic Model/Get-FabricSemanticModelDefinition.ps1 +++ b/source/Public/Semantic Model/Get-FabricSemanticModelDefinition.ps1 @@ -1,36 +1,41 @@ -<# -.SYNOPSIS - Retrieves the definition of an SemanticModel from a specified Microsoft Fabric workspace. +function Get-FabricSemanticModelDefinition { + <# + .SYNOPSIS + Retrieves the definition of an SemanticModel from a specified Microsoft Fabric workspace. -.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. + .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. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SemanticModel exists. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SemanticModel exists. This parameter is mandatory. -.PARAMETER SemanticModelId - The unique identifier of the SemanticModel to retrieve the definition for. This parameter is optional. + .PARAMETER SemanticModelId + The unique identifier of the SemanticModel to retrieve the definition for. This parameter is optional. -.PARAMETER SemanticModelFormat - The format in which to retrieve the SemanticModel definition. This parameter is optional. + .PARAMETER SemanticModelFormat + The format in which to retrieve the SemanticModel definition. This parameter is optional. -.EXAMPLE - Get-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" - This example retrieves the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345". + .EXAMPLE + This example retrieves the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345". -.EXAMPLE - Get-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelFormat "json" - This example retrieves the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" in JSON format. + ```powershell + Get-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" + ``` -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + This example retrieves the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" in JSON format. - Author: Tiago Balabuch + ```powershell + Get-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelFormat "json" + ``` -#> -function Get-FabricSemanticModelDefinition { + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Semantic Model/New-FabricSemanticModel.ps1 b/source/Public/Semantic Model/New-FabricSemanticModel.ps1 index 3e430fbd..cd47ac08 100644 --- a/source/Public/Semantic Model/New-FabricSemanticModel.ps1 +++ b/source/Public/Semantic Model/New-FabricSemanticModel.ps1 @@ -1,36 +1,38 @@ -<# -.SYNOPSIS - Creates a new SemanticModel in a specified Microsoft Fabric workspace. +function New-FabricSemanticModel +{ + <# + .SYNOPSIS + Creates a new SemanticModel in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a POST request to the Microsoft Fabric API to create a new SemanticModel - in the specified workspace. It supports optional parameters for SemanticModel description and path definitions. + .DESCRIPTION + This function sends a POST request to the Microsoft Fabric API to create a new SemanticModel + in the specified workspace. It supports optional parameters for SemanticModel description and path definitions. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SemanticModel will be created. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SemanticModel will be created. This parameter is mandatory. -.PARAMETER SemanticModelName - The name of the SemanticModel to be created. This parameter is mandatory. + .PARAMETER SemanticModelName + The name of the SemanticModel to be created. This parameter is mandatory. -.PARAMETER SemanticModelDescription - An optional description for the SemanticModel. + .PARAMETER SemanticModelDescription + An optional description for the SemanticModel. -.PARAMETER SemanticModelPathDefinition - An optional path to the SemanticModel definition file to upload. + .PARAMETER SemanticModelPathDefinition + An optional path to the SemanticModel definition file to upload. -.EXAMPLE - New-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelName "New SemanticModel" -SemanticModelDescription "Description of the new SemanticModel" - This example creates a new SemanticModel named "New SemanticModel" in the workspace with ID "workspace-12345" with the provided description. + .EXAMPLE + This example creates a new SemanticModel named "New SemanticModel" in the workspace with ID "workspace-12345" with the provided description. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + New-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelName "New SemanticModel" -SemanticModelDescription "Description of the new SemanticModel" + ``` - Author: Tiago Balabuch + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> -function New-FabricSemanticModel -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Semantic Model/Remove-FabricSemanticModel.ps1 b/source/Public/Semantic Model/Remove-FabricSemanticModel.ps1 index 25fd7c53..fe09a5c3 100644 --- a/source/Public/Semantic Model/Remove-FabricSemanticModel.ps1 +++ b/source/Public/Semantic Model/Remove-FabricSemanticModel.ps1 @@ -1,30 +1,32 @@ -<# -.SYNOPSIS - Removes an SemanticModel from a specified Microsoft Fabric workspace. +function Remove-FabricSemanticModel +{ + <# + .SYNOPSIS + Removes an SemanticModel from a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a DELETE request to the Microsoft Fabric API to remove an SemanticModel - from the specified workspace using the provided WorkspaceId and SemanticModelId. + .DESCRIPTION + This function sends a DELETE request to the Microsoft Fabric API to remove an SemanticModel + from the specified workspace using the provided WorkspaceId and SemanticModelId. -.PARAMETER WorkspaceId - The unique identifier of the workspace from which the SemanticModel will be removed. + .PARAMETER WorkspaceId + The unique identifier of the workspace from which the SemanticModel will be removed. -.PARAMETER SemanticModelId - The unique identifier of the SemanticModel to be removed. + .PARAMETER SemanticModelId + The unique identifier of the SemanticModel to be removed. -.EXAMPLE - Remove-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" - This example removes the SemanticModel with ID "SemanticModel-67890" from the workspace with ID "workspace-12345". + .EXAMPLE + This example removes the SemanticModel with ID "SemanticModel-67890" from the workspace with ID "workspace-12345". -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Remove-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" + ``` - Author: Tiago Balabuch + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> -function Remove-FabricSemanticModel -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Semantic Model/Update-FabricSemanticModel.ps1 b/source/Public/Semantic Model/Update-FabricSemanticModel.ps1 index e96114c3..cee395b1 100644 --- a/source/Public/Semantic Model/Update-FabricSemanticModel.ps1 +++ b/source/Public/Semantic Model/Update-FabricSemanticModel.ps1 @@ -1,36 +1,38 @@ -<# -.SYNOPSIS - Updates an existing SemanticModel in a specified Microsoft Fabric workspace. +function Update-FabricSemanticModel +{ + <# + .SYNOPSIS + Updates an existing SemanticModel in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a PATCH request to the Microsoft Fabric API to update an existing SemanticModel - in the specified workspace. It supports optional parameters for SemanticModel description. + .DESCRIPTION + This function sends a PATCH request to the Microsoft Fabric API to update an existing SemanticModel + in the specified workspace. It supports optional parameters for SemanticModel description. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SemanticModel exists. This parameter is optional. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SemanticModel exists. This parameter is optional. -.PARAMETER SemanticModelId - The unique identifier of the SemanticModel to be updated. This parameter is mandatory. + .PARAMETER SemanticModelId + The unique identifier of the SemanticModel to be updated. This parameter is mandatory. -.PARAMETER SemanticModelName - The new name of the SemanticModel. This parameter is mandatory. + .PARAMETER SemanticModelName + The new name of the SemanticModel. This parameter is mandatory. -.PARAMETER SemanticModelDescription - An optional new description for the SemanticModel. + .PARAMETER SemanticModelDescription + An optional new description for the SemanticModel. -.EXAMPLE - Update-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelName "Updated SemanticModel" -SemanticModelDescription "Updated description" - This example updates the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" with a new name and description. + .EXAMPLE + This example updates the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" with a new name and description. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Update-FabricSemanticModel -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelName "Updated SemanticModel" -SemanticModelDescription "Updated description" + ``` - Author: Tiago Balabuch + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> -function Update-FabricSemanticModel -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Semantic Model/Update-FabricSemanticModelDefinition.ps1 b/source/Public/Semantic Model/Update-FabricSemanticModelDefinition.ps1 index f737fbc9..6fcc5252 100644 --- a/source/Public/Semantic Model/Update-FabricSemanticModelDefinition.ps1 +++ b/source/Public/Semantic Model/Update-FabricSemanticModelDefinition.ps1 @@ -1,33 +1,35 @@ -<# -.SYNOPSIS - Updates the definition of an existing SemanticModel in a specified Microsoft Fabric workspace. +function Update-FabricSemanticModelDefinition +{ + <# + .SYNOPSIS + Updates the definition of an existing SemanticModel in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SemanticModel - in the specified workspace. It supports optional parameters for SemanticModel definition and platform-specific definition. + .DESCRIPTION + This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SemanticModel + in the specified workspace. It supports optional parameters for SemanticModel definition and platform-specific definition. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SemanticModel exists. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SemanticModel exists. This parameter is mandatory. -.PARAMETER SemanticModelId - The unique identifier of the SemanticModel to be updated. This parameter is mandatory. + .PARAMETER SemanticModelId + The unique identifier of the SemanticModel to be updated. This parameter is mandatory. -.PARAMETER SemanticModelPathDefinition - An optional path to the SemanticModel definition file to upload. + .PARAMETER SemanticModelPathDefinition + An optional path to the SemanticModel definition file to upload. -.EXAMPLE - Update-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelPathDefinition "C:\Path\To\SemanticModelDefinition.json" - This example updates the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" using the provided definition file. + .EXAMPLE + This example updates the definition of the SemanticModel with ID "SemanticModel-67890" in the workspace with ID "workspace-12345" using the provided definition file. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Update-FabricSemanticModelDefinition -WorkspaceId "workspace-12345" -SemanticModelId "SemanticModel-67890" -SemanticModelPathDefinition "C:\Path\To\SemanticModelDefinition.json" + ``` - Author: Tiago Balabuch + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> -function Update-FabricSemanticModelDefinition -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark Job Definition/Get-FabricSparkJobDefinition.ps1 b/source/Public/Spark Job Definition/Get-FabricSparkJobDefinition.ps1 index 577eff01..d977a27b 100644 --- a/source/Public/Spark Job Definition/Get-FabricSparkJobDefinition.ps1 +++ b/source/Public/Spark Job Definition/Get-FabricSparkJobDefinition.ps1 @@ -1,36 +1,41 @@ -<# -.SYNOPSIS - Retrieves Spark Job Definition details from a specified Microsoft Fabric workspace. +function Get-FabricSparkJobDefinition { + <# + .SYNOPSIS + Retrieves Spark Job Definition details from a specified Microsoft Fabric workspace. -.DESCRIPTION - This function retrieves SparkJobDefinition details from a specified workspace using either the provided SparkJobDefinitionId or SparkJobDefinitionName. - It handles token validation, constructs the API URL, makes the API request, and processes the response. + .DESCRIPTION + This function retrieves SparkJobDefinition details from a specified workspace using either the provided SparkJobDefinitionId or SparkJobDefinitionName. + It handles token validation, constructs the API URL, makes the API request, and processes the response. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is mandatory. -.PARAMETER SparkJobDefinitionId - The unique identifier of the SparkJobDefinition to retrieve. This parameter is optional. + .PARAMETER SparkJobDefinitionId + The unique identifier of the SparkJobDefinition to retrieve. This parameter is optional. -.PARAMETER SparkJobDefinitionName - The name of the SparkJobDefinition to retrieve. This parameter is optional. + .PARAMETER SparkJobDefinitionName + The name of the SparkJobDefinition to retrieve. This parameter is optional. -.EXAMPLE - Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" - This example retrieves the SparkJobDefinition details for the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345". + .EXAMPLE + This example retrieves the SparkJobDefinition details for the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345". -.EXAMPLE - Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionName "My SparkJobDefinition" - This example retrieves the SparkJobDefinition details for the SparkJobDefinition named "My SparkJobDefinition" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" + ``` -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + This example retrieves the SparkJobDefinition details for the SparkJobDefinition named "My SparkJobDefinition" in the workspace with ID "workspace-12345". - Author: Tiago Balabuch + ```powershell + Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionName "My SparkJobDefinition" + ``` -#> -function Get-FabricSparkJobDefinition { + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark Job Definition/Get-FabricSparkJobDefinitionDefinition.ps1 b/source/Public/Spark Job Definition/Get-FabricSparkJobDefinitionDefinition.ps1 index ca287da6..41c7e72f 100644 --- a/source/Public/Spark Job Definition/Get-FabricSparkJobDefinitionDefinition.ps1 +++ b/source/Public/Spark Job Definition/Get-FabricSparkJobDefinitionDefinition.ps1 @@ -1,35 +1,41 @@ -<# -.SYNOPSIS - Retrieves the definition of an SparkJobDefinition from a specified Microsoft Fabric workspace. +function Get-FabricSparkJobDefinitionDefinition { + <# + .SYNOPSIS + Retrieves the definition of an SparkJobDefinition from a specified Microsoft Fabric workspace. -.DESCRIPTION - This function retrieves the definition of an SparkJobDefinition from a specified workspace using the provided SparkJobDefinitionId. - It handles token validation, constructs the API URL, makes the API request, and processes the response. + .DESCRIPTION + This function retrieves the definition of an SparkJobDefinition from a specified workspace using the provided SparkJobDefinitionId. + It handles token validation, constructs the API URL, makes the API request, and processes the response. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is mandatory. -.PARAMETER SparkJobDefinitionId - The unique identifier of the SparkJobDefinition to retrieve the definition for. This parameter is optional. + .PARAMETER SparkJobDefinitionId + The unique identifier of the SparkJobDefinition to retrieve the definition for. This parameter is optional. -.PARAMETER SparkJobDefinitionFormat - The format in which to retrieve the SparkJobDefinition definition. This parameter is optional. + .PARAMETER SparkJobDefinitionFormat + The format in which to retrieve the SparkJobDefinition definition. This parameter is optional. -.EXAMPLE - Get-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" - This example retrieves the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345". + .EXAMPLE + This example retrieves the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345". -.EXAMPLE - Get-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionFormat "json" - This example retrieves the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" in JSON format. + ```powershell + Get-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" + ``` -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + This example retrieves the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" in JSON format. - Author: Tiago Balabuch -#> -function Get-FabricSparkJobDefinitionDefinition { + ```powershell + Get-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionFormat "json" + ``` + + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark Job Definition/New-FabricSparkJobDefinition.ps1 b/source/Public/Spark Job Definition/New-FabricSparkJobDefinition.ps1 index 1030e190..234751c5 100644 --- a/source/Public/Spark Job Definition/New-FabricSparkJobDefinition.ps1 +++ b/source/Public/Spark Job Definition/New-FabricSparkJobDefinition.ps1 @@ -1,38 +1,41 @@ -<# -.SYNOPSIS - Creates a new SparkJobDefinition in a specified Microsoft Fabric workspace. +function New-FabricSparkJobDefinition +{ + <# + .SYNOPSIS + Creates a new SparkJobDefinition in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a POST request to the Microsoft Fabric API to create a new SparkJobDefinition - in the specified workspace. It supports optional parameters for SparkJobDefinition description and path definitions. + .DESCRIPTION + This function sends a POST request to the Microsoft Fabric API to create a new SparkJobDefinition + in the specified workspace. It supports optional parameters for SparkJobDefinition description and path definitions. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SparkJobDefinition will be created. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SparkJobDefinition will be created. This parameter is mandatory. -.PARAMETER SparkJobDefinitionName - The name of the SparkJobDefinition to be created. This parameter is mandatory. + .PARAMETER SparkJobDefinitionName + The name of the SparkJobDefinition to be created. This parameter is mandatory. -.PARAMETER SparkJobDefinitionDescription - An optional description for the SparkJobDefinition. + .PARAMETER SparkJobDefinitionDescription + An optional description for the SparkJobDefinition. -.PARAMETER SparkJobDefinitionPathDefinition - An optional path to the SparkJobDefinition definition file to upload. + .PARAMETER SparkJobDefinitionPathDefinition + An optional path to the SparkJobDefinition definition file to upload. -.PARAMETER SparkJobDefinitionPathPlatformDefinition - An optional path to the platform-specific definition file to upload. + .PARAMETER SparkJobDefinitionPathPlatformDefinition + An optional path to the platform-specific definition file to upload. -.EXAMPLE - New-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionName "New SparkJobDefinition" -SparkJobDefinitionDescription "Description of the new SparkJobDefinition" - This example creates a new SparkJobDefinition named "New SparkJobDefinition" in the workspace with ID "workspace-12345" with the provided description. + .EXAMPLE + This example creates a new SparkJobDefinition named "New SparkJobDefinition" in the workspace with ID "workspace-12345" with the provided description. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + New-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionName "New SparkJobDefinition" -SparkJobDefinitionDescription "Description of the new SparkJobDefinition" + ``` - Author: Tiago Balabuch -#> -function New-FabricSparkJobDefinition -{ + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark Job Definition/Remove-FabricSparkJobDefinition.ps1 b/source/Public/Spark Job Definition/Remove-FabricSparkJobDefinition.ps1 index 455f12c0..daefb4d6 100644 --- a/source/Public/Spark Job Definition/Remove-FabricSparkJobDefinition.ps1 +++ b/source/Public/Spark Job Definition/Remove-FabricSparkJobDefinition.ps1 @@ -1,29 +1,32 @@ -<# -.SYNOPSIS - Removes an SparkJobDefinition from a specified Microsoft Fabric workspace. +function Remove-FabricSparkJobDefinition +{ + <# + .SYNOPSIS + Removes an SparkJobDefinition from a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a DELETE request to the Microsoft Fabric API to remove an SparkJobDefinition - from the specified workspace using the provided WorkspaceId and SparkJobDefinitionId. + .DESCRIPTION + This function sends a DELETE request to the Microsoft Fabric API to remove an SparkJobDefinition + from the specified workspace using the provided WorkspaceId and SparkJobDefinitionId. -.PARAMETER WorkspaceId - The unique identifier of the workspace from which the SparkJobDefinition will be removed. + .PARAMETER WorkspaceId + The unique identifier of the workspace from which the SparkJobDefinition will be removed. -.PARAMETER SparkJobDefinitionId - The unique identifier of the SparkJobDefinition to be removed. + .PARAMETER SparkJobDefinitionId + The unique identifier of the SparkJobDefinition to be removed. -.EXAMPLE - Remove-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" - This example removes the SparkJobDefinition with ID "SparkJobDefinition-67890" from the workspace with ID "workspace-12345". + .EXAMPLE + This example removes the SparkJobDefinition with ID "SparkJobDefinition-67890" from the workspace with ID "workspace-12345". -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Remove-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" + ``` - Author: Tiago Balabuch -#> -function Remove-FabricSparkJobDefinition -{ + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark Job Definition/Start-FabricSparkJobDefinitionOnDemand.ps1 b/source/Public/Spark Job Definition/Start-FabricSparkJobDefinitionOnDemand.ps1 index 009aafa9..f7d7885b 100644 --- a/source/Public/Spark Job Definition/Start-FabricSparkJobDefinitionOnDemand.ps1 +++ b/source/Public/Spark Job Definition/Start-FabricSparkJobDefinitionOnDemand.ps1 @@ -1,37 +1,37 @@ -<# -.SYNOPSIS - Starts a Fabric Spark Job Definition on demand. - -.DESCRIPTION - This function initiates a Spark Job Definition on demand within a specified workspace. - It constructs the appropriate API endpoint URL and makes a POST request to start the job. - The function can optionally wait for the job to complete based on the 'waitForCompletion' parameter. - -.PARAMETER WorkspaceId - The ID of the workspace where the Spark Job Definition is located. This parameter is mandatory. +function Start-FabricSparkJobDefinitionOnDemand +{ + <# + .SYNOPSIS + Starts a Fabric Spark Job Definition on demand. -.PARAMETER SparkJobDefinitionId - The ID of the Spark Job Definition to be started. This parameter is mandatory. + .DESCRIPTION + This function initiates a Spark Job Definition on demand within a specified workspace. + It constructs the appropriate API endpoint URL and makes a POST request to start the job. + The function can optionally wait for the job to complete based on the 'waitForCompletion' parameter. -.PARAMETER JobType - The type of job to be started. The default value is 'sparkjob'. This parameter is optional. + .PARAMETER WorkspaceId + The ID of the workspace where the Spark Job Definition is located. This parameter is mandatory. -.PARAMETER waitForCompletion - A boolean flag indicating whether to wait for the job to complete. The default value is $false. This parameter is optional. + .PARAMETER SparkJobDefinitionId + The ID of the Spark Job Definition to be started. This parameter is mandatory. -.EXAMPLE - Start-FabricSparkJobDefinitionOnDemand -WorkspaceId "workspace123" -SparkJobDefinitionId "jobdef456" -waitForCompletion $true + .PARAMETER JobType + The type of job to be started. The default value is 'sparkjob'. This parameter is optional. -.NOTES - Ensure that the necessary authentication tokens are valid before running this function. - The function logs detailed messages for debugging and informational purposes. + .PARAMETER waitForCompletion + A boolean flag indicating whether to wait for the job to complete. The default value is $false. This parameter is optional. -Author: Tiago Balabuch + .EXAMPLE + ```powershell + Start-FabricSparkJobDefinitionOnDemand -WorkspaceId "workspace123" -SparkJobDefinitionId "jobdef456" -waitForCompletion $true + ``` -#> + .NOTES + Ensure that the necessary authentication tokens are valid before running this function. + The function logs detailed messages for debugging and informational purposes. -function Start-FabricSparkJobDefinitionOnDemand -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark Job Definition/Update-FabricSparkJobDefinition.ps1 b/source/Public/Spark Job Definition/Update-FabricSparkJobDefinition.ps1 index d3ef8e7c..50dcf33e 100644 --- a/source/Public/Spark Job Definition/Update-FabricSparkJobDefinition.ps1 +++ b/source/Public/Spark Job Definition/Update-FabricSparkJobDefinition.ps1 @@ -1,35 +1,38 @@ -<# -.SYNOPSIS - Updates an existing SparkJobDefinition in a specified Microsoft Fabric workspace. +function Update-FabricSparkJobDefinition +{ + <# + .SYNOPSIS + Updates an existing SparkJobDefinition in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a PATCH request to the Microsoft Fabric API to update an existing SparkJobDefinition - in the specified workspace. It supports optional parameters for SparkJobDefinition description. + .DESCRIPTION + This function sends a PATCH request to the Microsoft Fabric API to update an existing SparkJobDefinition + in the specified workspace. It supports optional parameters for SparkJobDefinition description. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is optional. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is optional. -.PARAMETER SparkJobDefinitionId - The unique identifier of the SparkJobDefinition to be updated. This parameter is mandatory. + .PARAMETER SparkJobDefinitionId + The unique identifier of the SparkJobDefinition to be updated. This parameter is mandatory. -.PARAMETER SparkJobDefinitionName - The new name of the SparkJobDefinition. This parameter is mandatory. + .PARAMETER SparkJobDefinitionName + The new name of the SparkJobDefinition. This parameter is mandatory. -.PARAMETER SparkJobDefinitionDescription - An optional new description for the SparkJobDefinition. + .PARAMETER SparkJobDefinitionDescription + An optional new description for the SparkJobDefinition. -.EXAMPLE - Update-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionName "Updated SparkJobDefinition" -SparkJobDefinitionDescription "Updated description" - This example updates the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" with a new name and description. + .EXAMPLE + This example updates the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" with a new name and description. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Update-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionName "Updated SparkJobDefinition" -SparkJobDefinitionDescription "Updated description" + ``` - Author: Tiago Balabuch -#> -function Update-FabricSparkJobDefinition -{ + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark Job Definition/Update-FabricSparkJobDefinitionDefinition.ps1 b/source/Public/Spark Job Definition/Update-FabricSparkJobDefinitionDefinition.ps1 index 88cbd0d5..e9eb3554 100644 --- a/source/Public/Spark Job Definition/Update-FabricSparkJobDefinitionDefinition.ps1 +++ b/source/Public/Spark Job Definition/Update-FabricSparkJobDefinitionDefinition.ps1 @@ -1,35 +1,38 @@ -<# -.SYNOPSIS - Updates the definition of an existing SparkJobDefinition in a specified Microsoft Fabric workspace. +function Update-FabricSparkJobDefinitionDefinition +{ + <# + .SYNOPSIS + Updates the definition of an existing SparkJobDefinition in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SparkJobDefinition - in the specified workspace. It supports optional parameters for SparkJobDefinition definition and platform-specific definition. + .DESCRIPTION + This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing SparkJobDefinition + in the specified workspace. It supports optional parameters for SparkJobDefinition definition and platform-specific definition. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is mandatory. -.PARAMETER SparkJobDefinitionId - The unique identifier of the SparkJobDefinition to be updated. This parameter is mandatory. + .PARAMETER SparkJobDefinitionId + The unique identifier of the SparkJobDefinition to be updated. This parameter is mandatory. -.PARAMETER SparkJobDefinitionPathDefinition - An optional path to the SparkJobDefinition definition file to upload. + .PARAMETER SparkJobDefinitionPathDefinition + An optional path to the SparkJobDefinition definition file to upload. -.PARAMETER SparkJobDefinitionPathPlatformDefinition - An optional path to the platform-specific definition file to upload. + .PARAMETER SparkJobDefinitionPathPlatformDefinition + An optional path to the platform-specific definition file to upload. -.EXAMPLE - Update-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionPathDefinition "C:\Path\To\SparkJobDefinitionDefinition.json" - This example updates the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" using the provided definition file. + .EXAMPLE + This example updates the definition of the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" using the provided definition file. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Update-FabricSparkJobDefinitionDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionPathDefinition "C:\Path\To\SparkJobDefinitionDefinition.json" + ``` - Author: Tiago Balabuch -#> -function Update-FabricSparkJobDefinitionDefinition -{ + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark/Get-FabricSparkCustomPool.ps1 b/source/Public/Spark/Get-FabricSparkCustomPool.ps1 index f9a59ac1..32c5d3c3 100644 --- a/source/Public/Spark/Get-FabricSparkCustomPool.ps1 +++ b/source/Public/Spark/Get-FabricSparkCustomPool.ps1 @@ -1,41 +1,50 @@ -<# -.SYNOPSIS - Retrieves Spark custom pools from a specified workspace. +function Get-FabricSparkCustomPool { + <# + .SYNOPSIS + Retrieves Spark custom pools from a specified workspace. -.DESCRIPTION - This function retrieves all Spark custom pools from a specified workspace using the provided WorkspaceId. - It handles token validation, constructs the API URL, makes the API request, and processes the response. - The function supports filtering by SparkCustomPoolId or SparkCustomPoolName, but not both simultaneously. + .DESCRIPTION + This function retrieves all Spark custom pools from a specified workspace using the provided WorkspaceId. + It handles token validation, constructs the API URL, makes the API request, and processes the response. + The function supports filtering by SparkCustomPoolId or SparkCustomPoolName, but not both simultaneously. -.PARAMETER WorkspaceId - The ID of the workspace from which to retrieve Spark custom pools. This parameter is mandatory. + .PARAMETER WorkspaceId + The ID of the workspace from which to retrieve Spark custom pools. This parameter is mandatory. -.PARAMETER SparkCustomPoolId - The ID of the specific Spark custom pool to retrieve. This parameter is optional. + .PARAMETER SparkCustomPoolId + The ID of the specific Spark custom pool to retrieve. This parameter is optional. -.PARAMETER SparkCustomPoolName - The name of the specific Spark custom pool to retrieve. This parameter is optional. + .PARAMETER SparkCustomPoolName + The name of the specific Spark custom pool to retrieve. This parameter is optional. -.EXAMPLE - Get-FabricSparkCustomPool -WorkspaceId "12345" - This example retrieves all Spark custom pools from the workspace with ID "12345". + .EXAMPLE + This example retrieves all Spark custom pools from the workspace with ID "12345". -.EXAMPLE - Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolId "pool1" - This example retrieves the Spark custom pool with ID "pool1" from the workspace with ID "12345". + ```powershell + Get-FabricSparkCustomPool -WorkspaceId "12345" + ``` -.EXAMPLE - Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolName "MyPool" - This example retrieves the Spark custom pool with name "MyPool" from the workspace with ID "12345". + .EXAMPLE + This example retrieves the Spark custom pool with ID "pool1" from the workspace with ID "12345". -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. - - Handles continuation tokens to retrieve all Spark custom pools if there are multiple pages of results. + ```powershell + Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolId "pool1" + ``` - Author: Tiago Balabuch -#> -function Get-FabricSparkCustomPool { + .EXAMPLE + This example retrieves the Spark custom pool with name "MyPool" from the workspace with ID "12345". + + ```powershell + Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolName "MyPool" + ``` + + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + - Handles continuation tokens to retrieve all Spark custom pools if there are multiple pages of results. + + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark/Get-FabricSparkSettings.ps1 b/source/Public/Spark/Get-FabricSparkSettings.ps1 index c4681a4d..fa1c6905 100644 --- a/source/Public/Spark/Get-FabricSparkSettings.ps1 +++ b/source/Public/Spark/Get-FabricSparkSettings.ps1 @@ -1,26 +1,28 @@ -<# -.SYNOPSIS - Retrieves Spark settings from a specified Microsoft Fabric workspace. +function Get-FabricSparkSettings { + <# + .SYNOPSIS + Retrieves Spark settings from a specified Microsoft Fabric workspace. -.DESCRIPTION - This function retrieves Spark settings from a specified workspace using the provided WorkspaceId. - It handles token validation, constructs the API URL, makes the API request, and processes the response. + .DESCRIPTION + This function retrieves Spark settings from a specified workspace using the provided WorkspaceId. + It handles token validation, constructs the API URL, makes the API request, and processes the response. -.PARAMETER WorkspaceId - The unique identifier of the workspace from which to retrieve Spark settings. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace from which to retrieve Spark settings. This parameter is mandatory. -.EXAMPLE - Get-FabricSparkSettings -WorkspaceId "workspace-12345" - This example retrieves the Spark settings for the workspace with ID "workspace-12345". + .EXAMPLE + This example retrieves the Spark settings for the workspace with ID "workspace-12345". -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Get-FabricSparkSettings -WorkspaceId "workspace-12345" + ``` - Author: Tiago Balabuch + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> -function Get-FabricSparkSettings { + Author: Tiago Balabuch + #> [CmdletBinding()] [OutputType([System.Object[]])] param ( diff --git a/source/Public/Spark/New-FabricSparkCustomPool.ps1 b/source/Public/Spark/New-FabricSparkCustomPool.ps1 index 899fd41a..3c801cb7 100644 --- a/source/Public/Spark/New-FabricSparkCustomPool.ps1 +++ b/source/Public/Spark/New-FabricSparkCustomPool.ps1 @@ -1,55 +1,56 @@ -<# -.SYNOPSIS - Creates a new Spark custom pool in a specified Microsoft Fabric workspace. - -.DESCRIPTION - This function sends a POST request to the Microsoft Fabric API to create a new Spark custom pool - in the specified workspace. It supports various parameters for Spark custom pool configuration. +function New-FabricSparkCustomPool +{ + <# + .SYNOPSIS + Creates a new Spark custom pool in a specified Microsoft Fabric workspace. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the Spark custom pool will be created. This parameter is mandatory. + .DESCRIPTION + This function sends a POST request to the Microsoft Fabric API to create a new Spark custom pool + in the specified workspace. It supports various parameters for Spark custom pool configuration. -.PARAMETER SparkCustomPoolName - The name of the Spark custom pool to be created. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the Spark custom pool will be created. This parameter is mandatory. -.PARAMETER NodeFamily - The family of nodes to be used in the Spark custom pool. This parameter is mandatory and must be 'MemoryOptimized'. + .PARAMETER SparkCustomPoolName + The name of the Spark custom pool to be created. This parameter is mandatory. -.PARAMETER NodeSize - The size of the nodes to be used in the Spark custom pool. This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. + .PARAMETER NodeFamily + The family of nodes to be used in the Spark custom pool. This parameter is mandatory and must be 'MemoryOptimized'. -.PARAMETER AutoScaleEnabled - Specifies whether auto-scaling is enabled for the Spark custom pool. This parameter is mandatory. + .PARAMETER NodeSize + The size of the nodes to be used in the Spark custom pool. This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. -.PARAMETER AutoScaleMinNodeCount - The minimum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. + .PARAMETER AutoScaleEnabled + Specifies whether auto-scaling is enabled for the Spark custom pool. This parameter is mandatory. -.PARAMETER AutoScaleMaxNodeCount - The maximum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. + .PARAMETER AutoScaleMinNodeCount + The minimum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. -.PARAMETER DynamicExecutorAllocationEnabled - Specifies whether dynamic executor allocation is enabled for the Spark custom pool. This parameter is mandatory. + .PARAMETER AutoScaleMaxNodeCount + The maximum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. -.PARAMETER DynamicExecutorAllocationMinExecutors - The minimum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. + .PARAMETER DynamicExecutorAllocationEnabled + Specifies whether dynamic executor allocation is enabled for the Spark custom pool. This parameter is mandatory. -.PARAMETER DynamicExecutorAllocationMaxExecutors - The maximum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. + .PARAMETER DynamicExecutorAllocationMinExecutors + The minimum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. -.EXAMPLE - New-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolName "New Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 - This example creates a new Spark custom pool named "New Spark Pool" in the workspace with ID "workspace-12345" with the specified configuration. + .PARAMETER DynamicExecutorAllocationMaxExecutors + The maximum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + This example creates a new Spark custom pool named "New Spark Pool" in the workspace with ID "workspace-12345" with the specified configuration. - Author: Tiago Balabuch + ```powershell + New-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolName "New Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 + ``` -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function New-FabricSparkCustomPool -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark/Remove-FabricSparkCustomPool.ps1 b/source/Public/Spark/Remove-FabricSparkCustomPool.ps1 index 6dcc2936..41414784 100644 --- a/source/Public/Spark/Remove-FabricSparkCustomPool.ps1 +++ b/source/Public/Spark/Remove-FabricSparkCustomPool.ps1 @@ -1,30 +1,32 @@ -<# -.SYNOPSIS - Removes a Spark custom pool from a specified Microsoft Fabric workspace. +function Remove-FabricSparkCustomPool +{ + <# + .SYNOPSIS + Removes a Spark custom pool from a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a DELETE request to the Microsoft Fabric API to remove a Spark custom pool - from the specified workspace using the provided WorkspaceId and SparkCustomPoolId. + .DESCRIPTION + This function sends a DELETE request to the Microsoft Fabric API to remove a Spark custom pool + from the specified workspace using the provided WorkspaceId and SparkCustomPoolId. -.PARAMETER WorkspaceId - The unique identifier of the workspace from which the Spark custom pool will be removed. + .PARAMETER WorkspaceId + The unique identifier of the workspace from which the Spark custom pool will be removed. -.PARAMETER SparkCustomPoolId - The unique identifier of the Spark custom pool to be removed. + .PARAMETER SparkCustomPoolId + The unique identifier of the Spark custom pool to be removed. -.EXAMPLE - Remove-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolId "pool-67890" - This example removes the Spark custom pool with ID "pool-67890" from the workspace with ID "workspace-12345". + .EXAMPLE + This example removes the Spark custom pool with ID "pool-67890" from the workspace with ID "workspace-12345". -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Remove-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolId "pool-67890" + ``` - Author: Tiago Balabuch + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> -function Remove-FabricSparkCustomPool -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark/Update-FabricSparkCustomPool.ps1 b/source/Public/Spark/Update-FabricSparkCustomPool.ps1 index 924d2fe1..3181fece 100644 --- a/source/Public/Spark/Update-FabricSparkCustomPool.ps1 +++ b/source/Public/Spark/Update-FabricSparkCustomPool.ps1 @@ -1,57 +1,59 @@ -<# -.SYNOPSIS - Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. +function Update-FabricSparkCustomPool +{ + <# + .SYNOPSIS + Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool - in the specified workspace. It supports various parameters for Spark custom pool configuration. + .DESCRIPTION + This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool + in the specified workspace. It supports various parameters for Spark custom pool configuration. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the Spark custom pool exists. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the Spark custom pool exists. This parameter is mandatory. -.PARAMETER SparkCustomPoolId - The unique identifier of the Spark custom pool to be updated. This parameter is mandatory. + .PARAMETER SparkCustomPoolId + The unique identifier of the Spark custom pool to be updated. This parameter is mandatory. -.PARAMETER InstancePoolName - The new name of the Spark custom pool. This parameter is mandatory. + .PARAMETER InstancePoolName + The new name of the Spark custom pool. This parameter is mandatory. -.PARAMETER NodeFamily - The family of nodes to be used in the Spark custom pool. This parameter is mandatory and must be 'MemoryOptimized'. + .PARAMETER NodeFamily + The family of nodes to be used in the Spark custom pool. This parameter is mandatory and must be 'MemoryOptimized'. -.PARAMETER NodeSize - The size of the nodes to be used in the Spark custom pool. This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. + .PARAMETER NodeSize + The size of the nodes to be used in the Spark custom pool. This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. -.PARAMETER AutoScaleEnabled - Specifies whether auto-scaling is enabled for the Spark custom pool. This parameter is mandatory. + .PARAMETER AutoScaleEnabled + Specifies whether auto-scaling is enabled for the Spark custom pool. This parameter is mandatory. -.PARAMETER AutoScaleMinNodeCount - The minimum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. + .PARAMETER AutoScaleMinNodeCount + The minimum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. -.PARAMETER AutoScaleMaxNodeCount - The maximum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. + .PARAMETER AutoScaleMaxNodeCount + The maximum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. -.PARAMETER DynamicExecutorAllocationEnabled - Specifies whether dynamic executor allocation is enabled for the Spark custom pool. This parameter is mandatory. + .PARAMETER DynamicExecutorAllocationEnabled + Specifies whether dynamic executor allocation is enabled for the Spark custom pool. This parameter is mandatory. -.PARAMETER DynamicExecutorAllocationMinExecutors - The minimum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. + .PARAMETER DynamicExecutorAllocationMinExecutors + The minimum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. -.PARAMETER DynamicExecutorAllocationMaxExecutors - The maximum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. + .PARAMETER DynamicExecutorAllocationMaxExecutors + The maximum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. -.EXAMPLE - Update-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolId "pool-67890" -InstancePoolName "Updated Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 - This example updates the Spark custom pool with ID "pool-67890" in the workspace with ID "workspace-12345" with a new name and configuration. + .EXAMPLE + This example updates the Spark custom pool with ID "pool-67890" in the workspace with ID "workspace-12345" with a new name and configuration. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Update-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolId "pool-67890" -InstancePoolName "Updated Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 + ``` - Author: Tiago Balabuch + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> -function Update-FabricSparkCustomPool -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Spark/Update-FabricSparkSettings.ps1 b/source/Public/Spark/Update-FabricSparkSettings.ps1 index 4445f534..26539e95 100644 --- a/source/Public/Spark/Update-FabricSparkSettings.ps1 +++ b/source/Public/Spark/Update-FabricSparkSettings.ps1 @@ -1,84 +1,87 @@ -<# -.SYNOPSIS - Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. +function Update-FabricSparkSettings +{ + <# + .SYNOPSIS + Updates an existing Spark custom pool in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool - in the specified workspace. It supports various parameters for Spark custom pool configuration. + .DESCRIPTION + This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool + in the specified workspace. It supports various parameters for Spark custom pool configuration. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the Spark custom pool exists. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the Spark custom pool exists. This parameter is mandatory. -.PARAMETER SparkSettingsId - The unique identifier of the Spark custom pool to be updated. This parameter is mandatory. + .PARAMETER SparkSettingsId + The unique identifier of the Spark custom pool to be updated. This parameter is mandatory. -.PARAMETER InstancePoolName - The new name of the Spark custom pool. This parameter is mandatory. + .PARAMETER InstancePoolName + The new name of the Spark custom pool. This parameter is mandatory. -.PARAMETER NodeFamily - The family of nodes to be used in the Spark custom pool. This parameter is mandatory and must be 'MemoryOptimized'. + .PARAMETER NodeFamily + The family of nodes to be used in the Spark custom pool. This parameter is mandatory and must be 'MemoryOptimized'. -.PARAMETER NodeSize - The size of the nodes to be used in the Spark custom pool. This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. + .PARAMETER NodeSize + The size of the nodes to be used in the Spark custom pool. This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. -.PARAMETER AutoScaleEnabled - Specifies whether auto-scaling is enabled for the Spark custom pool. This parameter is mandatory. + .PARAMETER AutoScaleEnabled + Specifies whether auto-scaling is enabled for the Spark custom pool. This parameter is mandatory. -.PARAMETER AutoScaleMinNodeCount - The minimum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. + .PARAMETER AutoScaleMinNodeCount + The minimum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. -.PARAMETER AutoScaleMaxNodeCount - The maximum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. + .PARAMETER AutoScaleMaxNodeCount + The maximum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. -.PARAMETER DynamicExecutorAllocationEnabled - Specifies whether dynamic executor allocation is enabled for the Spark custom pool. This parameter is mandatory. + .PARAMETER DynamicExecutorAllocationEnabled + Specifies whether dynamic executor allocation is enabled for the Spark custom pool. This parameter is mandatory. -.PARAMETER DynamicExecutorAllocationMinExecutors - The minimum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. + .PARAMETER DynamicExecutorAllocationMinExecutors + The minimum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. -.PARAMETER DynamicExecutorAllocationMaxExecutors - The maximum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. + .PARAMETER DynamicExecutorAllocationMaxExecutors + The maximum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. -.PARAMETER automaticLogEnabled - Specifies whether automatic logging is enabled for the Spark custom pool. This parameter is optional. + .PARAMETER automaticLogEnabled + Specifies whether automatic logging is enabled for the Spark custom pool. This parameter is optional. -.PARAMETER notebookInteractiveRunEnabled - Specifies whether notebook interactive run is enabled for the Spark custom pool. This parameter is optional. + .PARAMETER notebookInteractiveRunEnabled + Specifies whether notebook interactive run is enabled for the Spark custom pool. This parameter is optional. -.PARAMETER customizeComputeEnabled - Specifies whether compute customization is enabled for the Spark custom pool. This parameter is optional. + .PARAMETER customizeComputeEnabled + Specifies whether compute customization is enabled for the Spark custom pool. This parameter is optional. -.PARAMETER defaultPoolName - The name of the default pool for the Spark custom pool. This parameter is optional. + .PARAMETER defaultPoolName + The name of the default pool for the Spark custom pool. This parameter is optional. -.PARAMETER defaultPoolType - The type of the default pool for the Spark custom pool. This parameter is optional and must be either 'Workspace' or 'Capacity'. + .PARAMETER defaultPoolType + The type of the default pool for the Spark custom pool. This parameter is optional and must be either 'Workspace' or 'Capacity'. -.PARAMETER starterPoolMaxNode - The maximum number of nodes for the starter pool in the Spark custom pool. This parameter is optional. + .PARAMETER starterPoolMaxNode + The maximum number of nodes for the starter pool in the Spark custom pool. This parameter is optional. -.PARAMETER starterPoolMaxExecutors - The maximum number of executors for the starter pool in the Spark custom pool. This parameter is optional. + .PARAMETER starterPoolMaxExecutors + The maximum number of executors for the starter pool in the Spark custom pool. This parameter is optional. -.PARAMETER EnvironmentName - The name of the environment for the Spark custom pool. This parameter is optional. + .PARAMETER EnvironmentName + The name of the environment for the Spark custom pool. This parameter is optional. -.PARAMETER EnvironmentRuntimeVersion - The runtime version of the environment for the Spark custom pool. This parameter is optional. + .PARAMETER EnvironmentRuntimeVersion + The runtime version of the environment for the Spark custom pool. This parameter is optional. -.EXAMPLE - Update-FabricSparkSettings -WorkspaceId "workspace-12345" -SparkSettingsId "pool-67890" -InstancePoolName "Updated Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 - This example updates the Spark custom pool with ID "pool-67890" in the workspace with ID "workspace-12345" with a new name and configuration. + .EXAMPLE + This example updates the Spark custom pool with ID "pool-67890" in the workspace with ID "workspace-12345" with a new name and configuration. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Update-FabricSparkSettings -WorkspaceId "workspace-12345" -SparkSettingsId "pool-67890" -InstancePoolName "Updated Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10 + ``` - Author: Tiago Balabuch + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> -function Update-FabricSparkSettings -{ + Author: Tiago Balabuch + + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Tenant/Get-FabricCapacityTenantSettingOverrides.ps1 b/source/Public/Tenant/Get-FabricCapacityTenantSettingOverrides.ps1 index 3ebf7c01..b74f0470 100644 --- a/source/Public/Tenant/Get-FabricCapacityTenantSettingOverrides.ps1 +++ b/source/Public/Tenant/Get-FabricCapacityTenantSettingOverrides.ps1 @@ -1,30 +1,34 @@ -<# -.SYNOPSIS -Retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant. +function Get-FabricCapacityTenantSettingOverrides { + <# + .SYNOPSIS + Retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant. -.DESCRIPTION -The `Get-FabricCapacityTenantSettingOverrides` function retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant by making a GET request to the appropriate API endpoint. If a `capacityId` is provided, the function retrieves overrides for that specific capacity. Otherwise, it retrieves overrides for all capacities. + .DESCRIPTION + The `Get-FabricCapacityTenantSettingOverrides` function retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant by making a GET request to the appropriate API endpoint. If a `capacityId` is provided, the function retrieves overrides for that specific capacity. Otherwise, it retrieves overrides for all capacities. -.PARAMETER capacityId -The ID of the capacity for which tenant setting overrides should be retrieved. If not provided, overrides for all capacities will be retrieved. + .PARAMETER capacityId + The ID of the capacity for which tenant setting overrides should be retrieved. If not provided, overrides for all capacities will be retrieved. -.EXAMPLE -Get-FabricCapacityTenantSettingOverrides + .EXAMPLE + Returns all capacities tenant setting overrides. -Returns all capacities tenant setting overrides. + ```powershell + Get-FabricCapacityTenantSettingOverrides + ``` -.EXAMPLE -Get-FabricCapacityTenantSettingOverrides -capacityId "12345" + .EXAMPLE + Returns tenant setting overrides for the capacity with ID "12345". -Returns tenant setting overrides for the capacity with ID "12345". + ```powershell + Get-FabricCapacityTenantSettingOverrides -capacityId "12345" + ``` -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -Author: Tiago Balabuch -#> -function Get-FabricCapacityTenantSettingOverrides { + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $false)] diff --git a/source/Public/Tenant/Get-FabricDomainTenantSettingOverrides.ps1 b/source/Public/Tenant/Get-FabricDomainTenantSettingOverrides.ps1 index a8c50ff3..b0f67566 100644 --- a/source/Public/Tenant/Get-FabricDomainTenantSettingOverrides.ps1 +++ b/source/Public/Tenant/Get-FabricDomainTenantSettingOverrides.ps1 @@ -1,23 +1,25 @@ -<# -.SYNOPSIS -Retrieves tenant setting overrides for a specific domain or all capacities in the Fabric tenant. +function Get-FabricDomainTenantSettingOverrides { + <# + .SYNOPSIS + Retrieves tenant setting overrides for a specific domain or all capacities in the Fabric tenant. -.DESCRIPTION -The `Get-FabricDomainTenantSettingOverrides` function retrieves tenant setting overrides for all domains in the Fabric tenant by making a GET request to the designated API endpoint. The function ensures token validity before making the request and handles the response appropriately. + .DESCRIPTION + The `Get-FabricDomainTenantSettingOverrides` function retrieves tenant setting overrides for all domains in the Fabric tenant by making a GET request to the designated API endpoint. The function ensures token validity before making the request and handles the response appropriately. -.EXAMPLE -Get-FabricDomainTenantSettingOverrides + .EXAMPLE + Fetches tenant setting overrides for all domains in the Fabric tenant. -Fetches tenant setting overrides for all domains in the Fabric tenant. + ```powershell + Get-FabricDomainTenantSettingOverrides + ``` -.NOTES -- Requires the `$FabricConfig` global configuration, which must include `BaseUrl` and `FabricHeaders`. -- Ensures token validity by invoking `Confirm-TokenState` before making the API request. -- Logs detailed messages for debugging and error handling. + .NOTES + - Requires the `$FabricConfig` global configuration, which must include `BaseUrl` and `FabricHeaders`. + - Ensures token validity by invoking `Confirm-TokenState` before making the API request. + - Logs detailed messages for debugging and error handling. -Author: Tiago Balabuch -#> -function Get-FabricDomainTenantSettingOverrides { + Author: Tiago Balabuch + #> [CmdletBinding()] param ( ) diff --git a/source/Public/Tenant/Get-FabricTenantSetting.ps1 b/source/Public/Tenant/Get-FabricTenantSetting.ps1 index 2f423c24..d37737ee 100644 --- a/source/Public/Tenant/Get-FabricTenantSetting.ps1 +++ b/source/Public/Tenant/Get-FabricTenantSetting.ps1 @@ -1,32 +1,34 @@ -<# -.SYNOPSIS -Retrieves tenant settings from the Fabric environment. - -.DESCRIPTION -The `Get-FabricTenantSetting` function retrieves tenant settings for a Fabric environment by making a GET request to the appropriate API endpoint. Optionally, it filters the results by the `SettingTitle` parameter. - -.PARAMETER SettingTitle -(Optional) The title of a specific tenant setting to filter the results. +function Get-FabricTenantSetting { + <# + .SYNOPSIS + Retrieves tenant settings from the Fabric environment. -.EXAMPLE -Get-FabricTenantSetting + .DESCRIPTION + The `Get-FabricTenantSetting` function retrieves tenant settings for a Fabric environment by making a GET request to the appropriate API endpoint. Optionally, it filters the results by the `SettingTitle` parameter. -Returns all tenant settings. + .PARAMETER SettingTitle + (Optional) The title of a specific tenant setting to filter the results. -.EXAMPLE -Get-FabricTenantSetting -SettingTitle "SomeSetting" + .EXAMPLE + Returns all tenant settings. -Returns the tenant setting with the title "SomeSetting". + ```powershell + Get-FabricTenantSetting + ``` -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Is-TokenExpired` to ensure token validity before making the API request. + .EXAMPLE + Returns the tenant setting with the title "SomeSetting". -Author: Tiago Balabuch + ```powershell + Get-FabricTenantSetting -SettingTitle "SomeSetting" + ``` -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Is-TokenExpired` to ensure token validity before making the API request. -function Get-FabricTenantSetting { + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $false)] diff --git a/source/Public/Tenant/Get-FabricWorkspaceTenantSettingOverrides.ps1 b/source/Public/Tenant/Get-FabricWorkspaceTenantSettingOverrides.ps1 index 2040f9b5..42d4b302 100644 --- a/source/Public/Tenant/Get-FabricWorkspaceTenantSettingOverrides.ps1 +++ b/source/Public/Tenant/Get-FabricWorkspaceTenantSettingOverrides.ps1 @@ -1,22 +1,24 @@ -<# -.SYNOPSIS -Retrieves tenant setting overrides for all workspaces in the Fabric tenant. +function Get-FabricWorkspaceTenantSettingOverrides { + <# + .SYNOPSIS + Retrieves tenant setting overrides for all workspaces in the Fabric tenant. -.DESCRIPTION -The `Get-FabricWorkspaceTenantSettingOverrides` function retrieves tenant setting overrides for all workspaces in the Fabric tenant by making a GET request to the appropriate API endpoint. The function validates the authentication token before making the request and handles the response accordingly. + .DESCRIPTION + The `Get-FabricWorkspaceTenantSettingOverrides` function retrieves tenant setting overrides for all workspaces in the Fabric tenant by making a GET request to the appropriate API endpoint. The function validates the authentication token before making the request and handles the response accordingly. -.EXAMPLE -Get-FabricWorkspaceTenantSettingOverrides + .EXAMPLE + Returns all workspaces tenant setting overrides. -Returns all workspaces tenant setting overrides. + ```powershell + Get-FabricWorkspaceTenantSettingOverrides + ``` -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -Author: Tiago Balabuch -#> -function Get-FabricWorkspaceTenantSettingOverrides { + Author: Tiago Balabuch + #> [CmdletBinding()] param ( ) diff --git a/source/Public/Tenant/Revoke-FabricCapacityTenantSettingOverrides.ps1 b/source/Public/Tenant/Revoke-FabricCapacityTenantSettingOverrides.ps1 index 546ccc80..0ed2ae46 100644 --- a/source/Public/Tenant/Revoke-FabricCapacityTenantSettingOverrides.ps1 +++ b/source/Public/Tenant/Revoke-FabricCapacityTenantSettingOverrides.ps1 @@ -1,28 +1,30 @@ -<# -.SYNOPSIS -Removes a tenant setting override from a specific capacity in the Fabric tenant. +function Revoke-FabricCapacityTenantSettingOverrides { + <# + .SYNOPSIS + Removes a tenant setting override from a specific capacity in the Fabric tenant. -.DESCRIPTION -The `Revoke-FabricCapacityTenantSettingOverrides` function deletes a specific tenant setting override for a given capacity in the Fabric tenant by making a DELETE request to the appropriate API endpoint. + .DESCRIPTION + The `Revoke-FabricCapacityTenantSettingOverrides` function deletes a specific tenant setting override for a given capacity in the Fabric tenant by making a DELETE request to the appropriate API endpoint. -.PARAMETER capacityId -The unique identifier of the capacity from which the tenant setting override will be removed. + .PARAMETER capacityId + The unique identifier of the capacity from which the tenant setting override will be removed. -.PARAMETER tenantSettingName -The name of the tenant setting override to be removed. + .PARAMETER tenantSettingName + The name of the tenant setting override to be removed. -.EXAMPLE -Revoke-FabricCapacityTenantSettingOverrides -capacityId "12345" -tenantSettingName "ExampleSetting" + .EXAMPLE + Removes the tenant setting override named "ExampleSetting" from the capacity with ID "12345". -Removes the tenant setting override named "ExampleSetting" from the capacity with ID "12345". + ```powershell + Revoke-FabricCapacityTenantSettingOverrides -capacityId "12345" -tenantSettingName "ExampleSetting" + ``` -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -Author: Tiago Balabuch -#> -function Revoke-FabricCapacityTenantSettingOverrides { + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Tenant/Update-FabricCapacityTenantSettingOverrides.ps1 b/source/Public/Tenant/Update-FabricCapacityTenantSettingOverrides.ps1 index 1e7e043b..7603f24b 100644 --- a/source/Public/Tenant/Update-FabricCapacityTenantSettingOverrides.ps1 +++ b/source/Public/Tenant/Update-FabricCapacityTenantSettingOverrides.ps1 @@ -1,48 +1,50 @@ -<# -.SYNOPSIS -Updates tenant setting overrides for a specified capacity ID. - -.DESCRIPTION -The `Update-FabricCapacityTenantSettingOverrides` function updates tenant setting overrides in a Fabric environment by making a POST request to the appropriate API endpoint. It allows specifying settings such as enabling tenant settings, delegating to a workspace, and including or excluding security groups. - -.PARAMETER CapacityId -(Mandatory) The ID of the capacity for which the tenant setting overrides are being updated. +function Update-FabricCapacityTenantSettingOverrides +{ + <# + .SYNOPSIS + Updates tenant setting overrides for a specified capacity ID. -.PARAMETER SettingTitle -(Mandatory) The title of the tenant setting to be updated. + .DESCRIPTION + The `Update-FabricCapacityTenantSettingOverrides` function updates tenant setting overrides in a Fabric environment by making a POST request to the appropriate API endpoint. It allows specifying settings such as enabling tenant settings, delegating to a workspace, and including or excluding security groups. -.PARAMETER EnableTenantSetting -(Mandatory) Indicates whether the tenant setting should be enabled. + .PARAMETER CapacityId + (Mandatory) The ID of the capacity for which the tenant setting overrides are being updated. -.PARAMETER DelegateToWorkspace -(Optional) Specifies the workspace to which the setting should be delegated. + .PARAMETER SettingTitle + (Mandatory) The title of the tenant setting to be updated. -.PARAMETER EnabledSecurityGroups -(Optional) A JSON array of security groups to be enabled, each containing `graphId` and `name` properties. + .PARAMETER EnableTenantSetting + (Mandatory) Indicates whether the tenant setting should be enabled. -.PARAMETER ExcludedSecurityGroups -(Optional) A JSON array of security groups to be excluded, each containing `graphId` and `name` properties. + .PARAMETER DelegateToWorkspace + (Optional) Specifies the workspace to which the setting should be delegated. -.EXAMPLE -Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" + .PARAMETER EnabledSecurityGroups + (Optional) A JSON array of security groups to be enabled, each containing `graphId` and `name` properties. -Updates the tenant setting "SomeSetting" for the capacity with ID "12345" and enables it. + .PARAMETER ExcludedSecurityGroups + (Optional) A JSON array of security groups to be excluded, each containing `graphId` and `name` properties. -.EXAMPLE -Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" -EnabledSecurityGroups @(@{graphId="1";name="Group1"},@{graphId="2";name="Group2"}) + .EXAMPLE + Updates the tenant setting "SomeSetting" for the capacity with ID "12345" and enables it. -Updates the tenant setting "SomeSetting" for the capacity with ID "12345", enables it, and specifies security groups to include. + ```powershell + Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" + ``` -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + Updates the tenant setting "SomeSetting" for the capacity with ID "12345", enables it, and specifies security groups to include. -Author: Tiago Balabuch + ```powershell + Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" -EnabledSecurityGroups @(@{graphId="1";name="Group1"},@{graphId="2";name="Group2"}) + ``` -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Update-FabricCapacityTenantSettingOverrides -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Tenant/Update-FabricTenantSetting.ps1 b/source/Public/Tenant/Update-FabricTenantSetting.ps1 index c55bea90..a3c84a05 100644 --- a/source/Public/Tenant/Update-FabricTenantSetting.ps1 +++ b/source/Public/Tenant/Update-FabricTenantSetting.ps1 @@ -1,48 +1,50 @@ -<# -.SYNOPSIS -Updates tenant setting overrides for a specified capacity ID. - -.DESCRIPTION -The `Update-FabricCapacityTenantSettingOverrides` function updates tenant setting overrides in a Fabric environment by making a POST request to the appropriate API endpoint. It allows specifying settings such as enabling tenant settings, delegating to a workspace, and including or excluding security groups. - -.PARAMETER CapacityId -(Mandatory) The ID of the capacity for which the tenant setting overrides are being updated. +function Update-FabricCapacityTenantSettingOverrides +{ + <# + .SYNOPSIS + Updates tenant setting overrides for a specified capacity ID. -.PARAMETER SettingTitle -(Mandatory) The title of the tenant setting to be updated. + .DESCRIPTION + The `Update-FabricCapacityTenantSettingOverrides` function updates tenant setting overrides in a Fabric environment by making a POST request to the appropriate API endpoint. It allows specifying settings such as enabling tenant settings, delegating to a workspace, and including or excluding security groups. -.PARAMETER EnableTenantSetting -(Mandatory) Indicates whether the tenant setting should be enabled. + .PARAMETER CapacityId + (Mandatory) The ID of the capacity for which the tenant setting overrides are being updated. -.PARAMETER DelegateToWorkspace -(Optional) Specifies the workspace to which the setting should be delegated. + .PARAMETER SettingTitle + (Mandatory) The title of the tenant setting to be updated. -.PARAMETER EnabledSecurityGroups -(Optional) A JSON array of security groups to be enabled, each containing `graphId` and `name` properties. + .PARAMETER EnableTenantSetting + (Mandatory) Indicates whether the tenant setting should be enabled. -.PARAMETER ExcludedSecurityGroups -(Optional) A JSON array of security groups to be excluded, each containing `graphId` and `name` properties. + .PARAMETER DelegateToWorkspace + (Optional) Specifies the workspace to which the setting should be delegated. -.EXAMPLE -Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" + .PARAMETER EnabledSecurityGroups + (Optional) A JSON array of security groups to be enabled, each containing `graphId` and `name` properties. -Updates the tenant setting "SomeSetting" for the capacity with ID "12345" and enables it. + .PARAMETER ExcludedSecurityGroups + (Optional) A JSON array of security groups to be excluded, each containing `graphId` and `name` properties. -.EXAMPLE -Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" -EnabledSecurityGroups @(@{graphId="1";name="Group1"},@{graphId="2";name="Group2"}) + .EXAMPLE + Updates the tenant setting "SomeSetting" for the capacity with ID "12345" and enables it. -Updates the tenant setting "SomeSetting" for the capacity with ID "12345", enables it, and specifies security groups to include. + ```powershell + Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" + ``` -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + Updates the tenant setting "SomeSetting" for the capacity with ID "12345", enables it, and specifies security groups to include. -Author: Tiago Balabuch + ```powershell + Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" -EnabledSecurityGroups @(@{graphId="1";name="Group1"},@{graphId="2";name="Group2"}) + ``` -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Update-FabricCapacityTenantSettingOverrides -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Users/Get-FabricUserListAccessEntities.ps1 b/source/Public/Users/Get-FabricUserListAccessEntities.ps1 index cbfe4c43..0f3a4499 100644 --- a/source/Public/Users/Get-FabricUserListAccessEntities.ps1 +++ b/source/Public/Users/Get-FabricUserListAccessEntities.ps1 @@ -1,32 +1,38 @@ -<# -.SYNOPSIS - Retrieves access entities for a specified user in Microsoft Fabric. +function Get-FabricUserListAccessEntities { + <# + .SYNOPSIS + Retrieves access entities for a specified user in Microsoft Fabric. -.DESCRIPTION - This function retrieves a list of access entities associated with a specified user in Microsoft Fabric. - It supports filtering by entity type and handles token validation, constructs the API URL, makes the API request, and processes the response. + .DESCRIPTION + This function retrieves a list of access entities associated with a specified user in Microsoft Fabric. + It supports filtering by entity type and handles token validation, constructs the API URL, makes the API request, and processes the response. -.PARAMETER UserId - The unique identifier of the user whose access entities are to be retrieved. This parameter is mandatory. + .PARAMETER UserId + The unique identifier of the user whose access entities are to be retrieved. This parameter is mandatory. -.PARAMETER Type - The type of access entity to filter the results by. This parameter is optional and supports predefined values such as 'CopyJob', 'Dashboard', 'DataPipeline', etc. + .PARAMETER Type + The type of access entity to filter the results by. This parameter is optional and supports predefined values such as 'CopyJob', 'Dashboard', 'DataPipeline', etc. -.EXAMPLE - Get-FabricUserListAccessEntities -UserId "user-12345" - This example retrieves all access entities associated with the user having ID "user-12345". + .EXAMPLE + This example retrieves all access entities associated with the user having ID "user-12345". -.EXAMPLE - Get-FabricUserListAccessEntities -UserId "user-12345" -Type "Dashboard" - This example retrieves only the 'Dashboard' access entities associated with the user having ID "user-12345". + ```powershell + Get-FabricUserListAccessEntities -UserId "user-12345" + ``` -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + This example retrieves only the 'Dashboard' access entities associated with the user having ID "user-12345". - Author: Tiago Balabuch -#> -function Get-FabricUserListAccessEntities { + ```powershell + Get-FabricUserListAccessEntities -UserId "user-12345" -Type "Dashboard" + ``` + + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Utils/Convert-FromBase64.ps1 b/source/Public/Utils/Convert-FromBase64.ps1 index 34696ab6..b9dd134e 100644 --- a/source/Public/Utils/Convert-FromBase64.ps1 +++ b/source/Public/Utils/Convert-FromBase64.ps1 @@ -12,17 +12,19 @@ function Convert-FromBase64 { The Base64-encoded string that you want to decode. .EXAMPLE - Convert-FromBase64 -Base64String "SGVsbG8sIFdvcmxkIQ==" + Output: Hello, World! - Output: - Hello, World! + ```powershell + Convert-FromBase64 -Base64String "SGVsbG8sIFdvcmxkIQ==" + ``` .EXAMPLE + Output: Some encoded text + + ```powershell $encodedString = "U29tZSBlbmNvZGVkIHRleHQ=" Convert-FromBase64 -Base64String $encodedString - - Output: - Some encoded text + ``` .NOTES This function assumes the Base64 input is a valid UTF-8 encoded string. diff --git a/source/Public/Utils/Convert-ToBase64.ps1 b/source/Public/Utils/Convert-ToBase64.ps1 index ed4f4649..48560bed 100644 --- a/source/Public/Utils/Convert-ToBase64.ps1 +++ b/source/Public/Utils/Convert-ToBase64.ps1 @@ -12,17 +12,21 @@ function Convert-ToBase64 { The full path to the file whose contents you want to encode into Base64. .EXAMPLE - Convert-ToBase64 -filePath "C:\Path\To\File.txt" + Output: VGhpcyBpcyBhbiBlbmNvZGVkIGZpbGUu - Output: - VGhpcyBpcyBhbiBlbmNvZGVkIGZpbGUu + ```powershell + Convert-ToBase64 -filePath "C:\Path\To\File.txt" + ``` .EXAMPLE - $encodedContent = Convert-ToBase64 -filePath "C:\Path\To\Image.jpg" - $encodedContent | Set-Content -Path "C:\Path\To\EncodedImage.txt" - This saves the Base64-encoded content of the image to a text file. + ```powershell + $encodedContent = Convert-ToBase64 -filePath "C:\Path\To\Image.jpg + + $encodedContent | Set-Content -Path "C:\Path\To\EncodedImage.txt" This saves the Base64-encoded content of the image to a text file. + ``` + .NOTES - Ensure the file exists at the specified path before running this function. - Large files may cause memory constraints due to full loading into memory. diff --git a/source/Public/Utils/Get-FabricLongRunningOperation.ps1 b/source/Public/Utils/Get-FabricLongRunningOperation.ps1 index 48c92296..4a0eaa0e 100644 --- a/source/Public/Utils/Get-FabricLongRunningOperation.ps1 +++ b/source/Public/Utils/Get-FabricLongRunningOperation.ps1 @@ -17,9 +17,11 @@ The URL provided in the Location header of the initial request. This is used to The interval (in seconds) to wait between polling the operation status. The default is 5 seconds. .EXAMPLE -Get-FabricLongRunningOperation -operationId "12345-abcd-67890-efgh" -retryAfter 10 + This command polls the status of the operation with the given operationId every 10 seconds until it completes. ```powershell ``` -This command polls the status of the operation with the given operationId every 10 seconds until it completes. + ```powershell + Get-FabricLongRunningOperation -operationId "12345-abcd-67890-efgh" -retryAfter 10 + ``` .NOTES diff --git a/source/Public/Utils/Get-FabricLongRunningOperationResult.ps1 b/source/Public/Utils/Get-FabricLongRunningOperationResult.ps1 index 4de9cb11..69f10759 100644 --- a/source/Public/Utils/Get-FabricLongRunningOperationResult.ps1 +++ b/source/Public/Utils/Get-FabricLongRunningOperationResult.ps1 @@ -11,9 +11,11 @@ of a specific long-running operation. This is typically used after confirming th The unique identifier of the completed long-running operation whose result you want to retrieve. .EXAMPLE -Get-FabricLongRunningOperationResult -operationId "12345-abcd-67890-efgh" + This command fetches the result of the operation with the specified operationId. ```powershell ``` -This command fetches the result of the operation with the specified operationId. + ```powershell + Get-FabricLongRunningOperationResult -operationId "12345-abcd-67890-efgh" + ``` .NOTES - Ensure the Fabric API headers (e.g., authorization tokens) are defined in $FabricConfig.FabricHeaders. diff --git a/source/Public/Utils/Invoke-FabricAPIRequest_duplicate.ps1 b/source/Public/Utils/Invoke-FabricAPIRequest_duplicate.ps1 index 764c31eb..69320a6e 100644 --- a/source/Public/Utils/Invoke-FabricAPIRequest_duplicate.ps1 +++ b/source/Public/Utils/Invoke-FabricAPIRequest_duplicate.ps1 @@ -33,14 +33,18 @@ function Invoke-FabricAPIRequest_duplicate { The number of times to retry the request in case of a 429 (Too Many Requests) error. The default value is 0. .EXAMPLE - Invoke-FabricAPIRequest_duplicate -uri "/api/resource" -method "Get" + This example sends a GET request to the "/api/resource" endpoint of the Fabric API. ```powershell ``` - This example sends a GET request to the "/api/resource" endpoint of the Fabric API. + ```powershell + Invoke-FabricAPIRequest_duplicate -uri "/api/resource" -method "Get" + ``` .EXAMPLE - Invoke-FabricAPIRequest_duplicate -authToken "abc123" -uri "/api/resource" -method "Post" -body $requestBody + This example sends a POST request to the "/api/resource" endpoint of the Fabric API with a request body. ```powershell ``` - This example sends a POST request to the "/api/resource" endpoint of the Fabric API with a request body. + ```powershell + Invoke-FabricAPIRequest_duplicate -authToken "abc123" -uri "/api/resource" -method "Post" -body $requestBody + ``` .NOTES This function requires the Get-FabricAuthToken function to be defined in the same script or module. diff --git a/source/Public/Warehouse/Get-FabricWarehouse.ps1 b/source/Public/Warehouse/Get-FabricWarehouse.ps1 index 62ecc305..95cad832 100644 --- a/source/Public/Warehouse/Get-FabricWarehouse.ps1 +++ b/source/Public/Warehouse/Get-FabricWarehouse.ps1 @@ -1,35 +1,41 @@ -<# -.SYNOPSIS - Retrieves warehouse details from a specified Microsoft Fabric workspace. +function Get-FabricWarehouse { + <# + .SYNOPSIS + Retrieves warehouse details from a specified Microsoft Fabric workspace. -.DESCRIPTION - This function retrieves warehouse details from a specified workspace using either the provided WarehouseId or WarehouseName. - It handles token validation, constructs the API URL, makes the API request, and processes the response. + .DESCRIPTION + This function retrieves warehouse details from a specified workspace using either the provided WarehouseId or WarehouseName. + It handles token validation, constructs the API URL, makes the API request, and processes the response. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the warehouse exists. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the warehouse exists. This parameter is mandatory. -.PARAMETER WarehouseId - The unique identifier of the warehouse to retrieve. This parameter is optional. + .PARAMETER WarehouseId + The unique identifier of the warehouse to retrieve. This parameter is optional. -.PARAMETER WarehouseName - The name of the warehouse to retrieve. This parameter is optional. + .PARAMETER WarehouseName + The name of the warehouse to retrieve. This parameter is optional. -.EXAMPLE - Get-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" - This example retrieves the warehouse details for the warehouse with ID "warehouse-67890" in the workspace with ID "workspace-12345". + .EXAMPLE + This example retrieves the warehouse details for the warehouse with ID "warehouse-67890" in the workspace with ID "workspace-12345". -.EXAMPLE - Get-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseName "My Warehouse" - This example retrieves the warehouse details for the warehouse named "My Warehouse" in the workspace with ID "workspace-12345". + ```powershell + Get-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" + ``` -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + This example retrieves the warehouse details for the warehouse named "My Warehouse" in the workspace with ID "workspace-12345". - Author: Tiago Balabuch -#> -function Get-FabricWarehouse { + ```powershell + Get-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseName "My Warehouse" + ``` + + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Warehouse/New-FabricWarehouse.ps1 b/source/Public/Warehouse/New-FabricWarehouse.ps1 index 6c28fbcf..3857126b 100644 --- a/source/Public/Warehouse/New-FabricWarehouse.ps1 +++ b/source/Public/Warehouse/New-FabricWarehouse.ps1 @@ -1,32 +1,35 @@ -<# -.SYNOPSIS - Creates a new warehouse in a specified Microsoft Fabric workspace. +function New-FabricWarehouse +{ + <# + .SYNOPSIS + Creates a new warehouse in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a POST request to the Microsoft Fabric API to create a new warehouse - in the specified workspace. It supports optional parameters for warehouse description. + .DESCRIPTION + This function sends a POST request to the Microsoft Fabric API to create a new warehouse + in the specified workspace. It supports optional parameters for warehouse description. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the warehouse will be created. This parameter is mandatory. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the warehouse will be created. This parameter is mandatory. -.PARAMETER WarehouseName - The name of the warehouse to be created. This parameter is mandatory. + .PARAMETER WarehouseName + The name of the warehouse to be created. This parameter is mandatory. -.PARAMETER WarehouseDescription - An optional description for the warehouse. + .PARAMETER WarehouseDescription + An optional description for the warehouse. -.EXAMPLE - New-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseName "New Warehouse" -WarehouseDescription "Description of the new warehouse" - This example creates a new warehouse named "New Warehouse" in the workspace with ID "workspace-12345" with the provided description. + .EXAMPLE + This example creates a new warehouse named "New Warehouse" in the workspace with ID "workspace-12345" with the provided description. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + New-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseName "New Warehouse" -WarehouseDescription "Description of the new warehouse" + ``` - Author: Tiago Balabuch -#> -function New-FabricWarehouse -{ + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Warehouse/Remove-FabricWarehouse.ps1 b/source/Public/Warehouse/Remove-FabricWarehouse.ps1 index 98c55289..ce6f9a4b 100644 --- a/source/Public/Warehouse/Remove-FabricWarehouse.ps1 +++ b/source/Public/Warehouse/Remove-FabricWarehouse.ps1 @@ -1,28 +1,30 @@ -<# -.SYNOPSIS - Removes a warehouse from a specified Microsoft Fabric workspace. +function Remove-FabricWarehouse +{ + <# + .SYNOPSIS + Removes a warehouse from a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a DELETE request to the Microsoft Fabric API to remove a warehouse - from the specified workspace using the provided WorkspaceId and WarehouseId. + .DESCRIPTION + This function sends a DELETE request to the Microsoft Fabric API to remove a warehouse + from the specified workspace using the provided WorkspaceId and WarehouseId. -.PARAMETER WorkspaceId - The unique identifier of the workspace from which the warehouse will be removed. + .PARAMETER WorkspaceId + The unique identifier of the workspace from which the warehouse will be removed. -.PARAMETER WarehouseId - The unique identifier of the warehouse to be removed. + .PARAMETER WarehouseId + The unique identifier of the warehouse to be removed. -.EXAMPLE - Remove-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" - This example removes the warehouse with ID "warehouse-67890" from the workspace with ID "workspace-12345". + .EXAMPLE + This example removes the warehouse with ID "warehouse-67890" from the workspace with ID "workspace-12345". -.NOTES - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Remove-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" + ``` + .NOTES + - Calls `Confirm-TokenState` to ensure token validity before making the API request. - Author: Tiago Balabuch -#> -function Remove-FabricWarehouse -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Warehouse/Update-FabricWarehouse.ps1 b/source/Public/Warehouse/Update-FabricWarehouse.ps1 index 4576c70b..242e1b5c 100644 --- a/source/Public/Warehouse/Update-FabricWarehouse.ps1 +++ b/source/Public/Warehouse/Update-FabricWarehouse.ps1 @@ -1,36 +1,39 @@ -<# -.SYNOPSIS - Updates an existing warehouse in a specified Microsoft Fabric workspace. +function Update-FabricWarehouse +{ + <# + .SYNOPSIS + Updates an existing warehouse in a specified Microsoft Fabric workspace. -.DESCRIPTION - This function sends a PATCH request to the Microsoft Fabric API to update an existing warehouse - in the specified workspace. It supports optional parameters for warehouse description. + .DESCRIPTION + This function sends a PATCH request to the Microsoft Fabric API to update an existing warehouse + in the specified workspace. It supports optional parameters for warehouse description. -.PARAMETER WorkspaceId - The unique identifier of the workspace where the warehouse exists. This parameter is optional. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the warehouse exists. This parameter is optional. -.PARAMETER WarehouseId - The unique identifier of the warehouse to be updated. This parameter is mandatory. + .PARAMETER WarehouseId + The unique identifier of the warehouse to be updated. This parameter is mandatory. -.PARAMETER WarehouseName - The new name of the warehouse. This parameter is mandatory. + .PARAMETER WarehouseName + The new name of the warehouse. This parameter is mandatory. -.PARAMETER WarehouseDescription - An optional new description for the warehouse. + .PARAMETER WarehouseDescription + An optional new description for the warehouse. -.EXAMPLE - Update-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" -WarehouseName "Updated Warehouse" -WarehouseDescription "Updated description" - This example updates the warehouse with ID "warehouse-67890" in the workspace with ID "workspace-12345" with a new name and description. + .EXAMPLE + This example updates the warehouse with ID "warehouse-67890" in the workspace with ID "workspace-12345" with a new name and description. -.NOTES - - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - - Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Update-FabricWarehouse -WorkspaceId "workspace-12345" -WarehouseId "warehouse-67890" -WarehouseName "Updated Warehouse" -WarehouseDescription "Updated description" + ``` - Author: Tiago Balabuch + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -#> -function Update-FabricWarehouse -{ + Author: Tiago Balabuch + + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Workspace/Add-FabricWorkspaceCapacityAssignment.ps1 b/source/Public/Workspace/Add-FabricWorkspaceCapacityAssignment.ps1 index d2569fdb..ceb2ecb9 100644 --- a/source/Public/Workspace/Add-FabricWorkspaceCapacityAssignment.ps1 +++ b/source/Public/Workspace/Add-FabricWorkspaceCapacityAssignment.ps1 @@ -1,29 +1,30 @@ -<# -.SYNOPSIS -Assigns a Fabric workspace to a specified capacity. - -.DESCRIPTION -The `Add-FabricWorkspaceCapacityAssignment` function sends a POST request to assign a workspace to a specific capacity. +function Add-FabricWorkspaceCapacityAssignment { + <# + .SYNOPSIS + Assigns a Fabric workspace to a specified capacity. -.PARAMETER WorkspaceId -The unique identifier of the workspace to be assigned. + .DESCRIPTION + The `Add-FabricWorkspaceCapacityAssignment` function sends a POST request to assign a workspace to a specific capacity. -.PARAMETER CapacityId -The unique identifier of the capacity to which the workspace should be assigned. + .PARAMETER WorkspaceId + The unique identifier of the workspace to be assigned. -.EXAMPLE -Add-FabricWorkspaceCapacityAssignment -WorkspaceId "workspace123" -CapacityId "capacity456" + .PARAMETER CapacityId + The unique identifier of the capacity to which the workspace should be assigned. -Assigns the workspace with ID "workspace123" to the capacity "capacity456". + .EXAMPLE + Assigns the workspace with ID "workspace123" to the capacity "capacity456". -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Add-FabricWorkspaceCapacityAssignment -WorkspaceId "workspace123" -CapacityId "capacity456" + ``` -Author: Tiago Balabuch -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Add-FabricWorkspaceCapacityAssignment { + Author: Tiago Balabuch + #> [CmdletBinding()] [Alias("Assign-FabricWorkspaceCapacity")] param ( diff --git a/source/Public/Workspace/Add-FabricWorkspaceIdentity.ps1 b/source/Public/Workspace/Add-FabricWorkspaceIdentity.ps1 index 31b3884e..ae7ce899 100644 --- a/source/Public/Workspace/Add-FabricWorkspaceIdentity.ps1 +++ b/source/Public/Workspace/Add-FabricWorkspaceIdentity.ps1 @@ -1,26 +1,27 @@ -<# -.SYNOPSIS -Provisions an identity for a Fabric workspace. - -.DESCRIPTION -The `Add-FabricWorkspaceIdentity` function provisions an identity for a specified workspace by making an API call. +function Add-FabricWorkspaceIdentity { + <# + .SYNOPSIS + Provisions an identity for a Fabric workspace. -.PARAMETER WorkspaceId -The unique identifier of the workspace for which the identity will be provisioned. + .DESCRIPTION + The `Add-FabricWorkspaceIdentity` function provisions an identity for a specified workspace by making an API call. -.EXAMPLE -Add-FabricWorkspaceIdentity -WorkspaceId "workspace123" + .PARAMETER WorkspaceId + The unique identifier of the workspace for which the identity will be provisioned. -Provisions a Managed Identity for the workspace with ID "workspace123". + .EXAMPLE + Provisions a Managed Identity for the workspace with ID "workspace123". -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Add-FabricWorkspaceIdentity -WorkspaceId "workspace123" + ``` -Author: Tiago Balabuch -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Add-FabricWorkspaceIdentity { + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Workspace/Add-FabricWorkspaceRoleAssignment.ps1 b/source/Public/Workspace/Add-FabricWorkspaceRoleAssignment.ps1 index 73733103..2e4d4f6d 100644 --- a/source/Public/Workspace/Add-FabricWorkspaceRoleAssignment.ps1 +++ b/source/Public/Workspace/Add-FabricWorkspaceRoleAssignment.ps1 @@ -1,35 +1,36 @@ -<# -.SYNOPSIS -Assigns a role to a principal for a specified Fabric workspace. - -.DESCRIPTION -The `Add-FabricWorkspaceRoleAssignments` function assigns a role (e.g., Admin, Contributor, Member, Viewer) to a principal (e.g., User, Group, ServicePrincipal) in a Fabric workspace by making a POST request to the API. +function Add-FabricWorkspaceRoleAssignment { + <# + .SYNOPSIS + Assigns a role to a principal for a specified Fabric workspace. -.PARAMETER WorkspaceId -The unique identifier of the workspace. + .DESCRIPTION + The `Add-FabricWorkspaceRoleAssignments` function assigns a role (e.g., Admin, Contributor, Member, Viewer) to a principal (e.g., User, Group, ServicePrincipal) in a Fabric workspace by making a POST request to the API. -.PARAMETER PrincipalId -The unique identifier of the principal (User, Group, etc.) to assign the role. + .PARAMETER WorkspaceId + The unique identifier of the workspace. -.PARAMETER PrincipalType -The type of the principal. Allowed values: Group, ServicePrincipal, ServicePrincipalProfile, User. + .PARAMETER PrincipalId + The unique identifier of the principal (User, Group, etc.) to assign the role. -.PARAMETER WorkspaceRole -The role to assign to the principal. Allowed values: Admin, Contributor, Member, Viewer. + .PARAMETER PrincipalType + The type of the principal. Allowed values: Group, ServicePrincipal, ServicePrincipalProfile, User. -.EXAMPLE -Add-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -PrincipalId "principal123" -PrincipalType "User" -WorkspaceRole "Admin" + .PARAMETER WorkspaceRole + The role to assign to the principal. Allowed values: Admin, Contributor, Member, Viewer. -Assigns the Admin role to the user with ID "principal123" in the workspace "workspace123". + .EXAMPLE + Assigns the Admin role to the user with ID "principal123" in the workspace "workspace123". -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Add-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -PrincipalId "principal123" -PrincipalType "User" -WorkspaceRole "Admin" + ``` -Author: Tiago Balabuch -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Add-FabricWorkspaceRoleAssignment { + Author: Tiago Balabuch + #> [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( diff --git a/source/Public/Workspace/Get-FabricWorkspace.ps1 b/source/Public/Workspace/Get-FabricWorkspace.ps1 index 8e977c0e..0f1f9847 100644 --- a/source/Public/Workspace/Get-FabricWorkspace.ps1 +++ b/source/Public/Workspace/Get-FabricWorkspace.ps1 @@ -1,35 +1,38 @@ -<# -.SYNOPSIS -Retrieves details of a Microsoft Fabric workspace by its ID or name. - -.DESCRIPTION -The `Get-FabricWorkspace` function fetches workspace details from the Fabric API. It supports filtering by WorkspaceId or WorkspaceName. +function Get-FabricWorkspace { + <# + .SYNOPSIS + Retrieves details of a Microsoft Fabric workspace by its ID or name. -.PARAMETER WorkspaceId -The unique identifier of the workspace to retrieve. + .DESCRIPTION + The `Get-FabricWorkspace` function fetches workspace details from the Fabric API. It supports filtering by WorkspaceId or WorkspaceName. -.PARAMETER WorkspaceName -The display name of the workspace to retrieve. + .PARAMETER WorkspaceId + The unique identifier of the workspace to retrieve. -.EXAMPLE -Get-FabricWorkspace -WorkspaceId "workspace123" + .PARAMETER WorkspaceName + The display name of the workspace to retrieve. -Fetches details of the workspace with ID "workspace123". + .EXAMPLE + Fetches details of the workspace with ID "workspace123". -.EXAMPLE -Get-FabricWorkspace -WorkspaceName "MyWorkspace" + ```powershell + Get-FabricWorkspace -WorkspaceId "workspace123" + ``` -Fetches details of the workspace with the name "MyWorkspace". + .EXAMPLE + Fetches details of the workspace with the name "MyWorkspace". -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. -- Returns the matching workspace details or all workspaces if no filter is provided. + ```powershell + Get-FabricWorkspace -WorkspaceName "MyWorkspace" + ``` -Author: Tiago Balabuch -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. + - Returns the matching workspace details or all workspaces if no filter is provided. -function Get-FabricWorkspace { + Author: Tiago Balabuch + #> [CmdletBinding()] param ( [Parameter(Mandatory = $false)] diff --git a/source/Public/Workspace/Get-FabricWorkspaceDatasetRefreshes.ps1 b/source/Public/Workspace/Get-FabricWorkspaceDatasetRefreshes.ps1 index 5d973647..dc6c72de 100644 --- a/source/Public/Workspace/Get-FabricWorkspaceDatasetRefreshes.ps1 +++ b/source/Public/Workspace/Get-FabricWorkspaceDatasetRefreshes.ps1 @@ -1,31 +1,31 @@ function Get-FabricWorkspaceDatasetRefreshes { <# -.SYNOPSIS - Retrieves the refresh history of all datasets in a specified PowerBI workspace. + .SYNOPSIS + Retrieves the refresh history of all datasets in a specified PowerBI workspace. -.DESCRIPTION - The Get-FabricWorkspaceDatasetRefreshes function uses the PowerBI cmdlets to retrieve the refresh history of all datasets in a specified workspace. - It uses the workspace ID to get the workspace and its datasets, and then retrieves the refresh history for each dataset. + .DESCRIPTION + The Get-FabricWorkspaceDatasetRefreshes function uses the PowerBI cmdlets to retrieve the refresh history of all datasets in a specified workspace. + It uses the workspace ID to get the workspace and its datasets, and then retrieves the refresh history for each dataset. -.PARAMETER WorkspaceID - The ID of the PowerBI workspace. This is a mandatory parameter. + .PARAMETER WorkspaceID + The ID of the PowerBI workspace. This is a mandatory parameter. -.EXAMPLE - Get-FabricWorkspaceDatasetRefreshes -WorkspaceID "12345678-90ab-cdef-1234-567890abcdef" + .EXAMPLE + This command retrieves the refresh history of all datasets in the workspace with the specified ID. .INPUTS String. You can pipe a string that contains the workspace ID to Get-FabricWorkspaceDatasetRefreshes. - This command retrieves the refresh history of all datasets in the workspace with the specified ID. + ```powershell + Get-FabricWorkspaceDatasetRefreshes -WorkspaceID "12345678-90ab-cdef-1234-567890abcdef" + ``` + .INPUTS + Guid. You can pipe a string that contains the workspace ID to Get-FabricWorkspaceDatasetRefreshes. -.INPUTS - String. You can pipe a string that contains the workspace ID to Get-FabricWorkspaceDatasetRefreshes. + .OUTPUTS + Array. Get-FabricWorkspaceDatasetRefreshes returns an array of refresh history objects. -.OUTPUTS - Array. Get-FabricWorkspaceDatasetRefreshes returns an array of refresh history objects. - -.NOTES - Alias: Get-PowerBIWorkspaceDatasetRefreshes, Get-FabWorkspaceDatasetRefreshes - - Author: Ioana Bouariu + .NOTES + Alias: Get-FabWorkspaceDatasetRefreshes + Author: Ioana Bouariu #> # Define a function to get the refresh history of all datasets in a PowerBI workspace diff --git a/source/Public/Workspace/Get-FabricWorkspaceRoleAssignment.ps1 b/source/Public/Workspace/Get-FabricWorkspaceRoleAssignment.ps1 index 301c49cb..6b90567e 100644 --- a/source/Public/Workspace/Get-FabricWorkspaceRoleAssignment.ps1 +++ b/source/Public/Workspace/Get-FabricWorkspaceRoleAssignment.ps1 @@ -1,34 +1,37 @@ -<# -.SYNOPSIS -Retrieves role assignments for a specified Fabric workspace. - -.DESCRIPTION -The `Get-FabricWorkspaceRoleAssignments` function fetches the role assignments associated with a Fabric workspace by making a GET request to the API. If `WorkspaceRoleAssignmentId` is provided, it retrieves the specific role assignment. +function Get-FabricWorkspaceRoleAssignment { + <# + .SYNOPSIS + Retrieves role assignments for a specified Fabric workspace. -.PARAMETER WorkspaceId -The unique identifier of the workspace to fetch role assignments for. + .DESCRIPTION + The `Get-FabricWorkspaceRoleAssignments` function fetches the role assignments associated with a Fabric workspace by making a GET request to the API. If `WorkspaceRoleAssignmentId` is provided, it retrieves the specific role assignment. -.PARAMETER WorkspaceRoleAssignmentId -(Optional) The unique identifier of a specific role assignment to retrieve. + .PARAMETER WorkspaceId + The unique identifier of the workspace to fetch role assignments for. -.EXAMPLE -Get-FabricWorkspaceRoleAssignments -WorkspaceId "workspace123" + .PARAMETER WorkspaceRoleAssignmentId + (Optional) The unique identifier of a specific role assignment to retrieve. -Fetches all role assignments for the workspace with the ID "workspace123". + .EXAMPLE + Fetches all role assignments for the workspace with the ID "workspace123". -.EXAMPLE -Get-FabricWorkspaceRoleAssignments -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "role123" + ```powershell + Get-FabricWorkspaceRoleAssignments -WorkspaceId "workspace123" + ``` -Fetches the role assignment with the ID "role123" for the workspace "workspace123". + .EXAMPLE + Fetches the role assignment with the ID "role123" for the workspace "workspace123". -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Get-FabricWorkspaceRoleAssignments -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "role123" + ``` -Author: Tiago Balabuch -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Get-FabricWorkspaceRoleAssignment { + Author: Tiago Balabuch + #> [CmdletBinding()] [OutputType([System.Object[]])] param ( diff --git a/source/Public/Workspace/Get-FabricWorkspaceUsageMetricsData.ps1 b/source/Public/Workspace/Get-FabricWorkspaceUsageMetricsData.ps1 index 6c362414..f19d16eb 100644 --- a/source/Public/Workspace/Get-FabricWorkspaceUsageMetricsData.ps1 +++ b/source/Public/Workspace/Get-FabricWorkspaceUsageMetricsData.ps1 @@ -13,9 +13,11 @@ The ID of the workspace. This is a mandatory parameter. The username. This is a mandatory parameter. .EXAMPLE -Get-FabricWorkspaceUsageMetricsData -workspaceId "your-workspace-id" -username "your-username" + This example retrieves the workspace usage metrics for a specific workspace given the workspace ID and username. -This example retrieves the workspace usage metrics for a specific workspace given the workspace ID and username. + ```powershell + Get-FabricWorkspaceUsageMetricsData -workspaceId "your-workspace-id" -username "your-username" + ``` .NOTES The function retrieves the PowerBI access token and creates a new usage metrics report. It then defines the names of the reports to retrieve, initializes an empty hashtable to store the reports, and for each report name, retrieves the report and adds it to the hashtable. It then returns the hashtable of reports. diff --git a/source/Public/Workspace/Get-FabricWorkspaceUser.ps1 b/source/Public/Workspace/Get-FabricWorkspaceUser.ps1 index 9281b587..a41353f5 100644 --- a/source/Public/Workspace/Get-FabricWorkspaceUser.ps1 +++ b/source/Public/Workspace/Get-FabricWorkspaceUser.ps1 @@ -14,32 +14,43 @@ The ID of the workspace. This is a mandatory parameter if Workspace is not provi The workspace object. This normally comes from the Get-FabricWorkspace cmdlet. This is a mandatory parameter if WorkspaceId is not provided. .EXAMPLE -Get-FabricWorkspaceUser -WorkspaceId '12345678-1234-1234-1234-123456789012 + This example retrieves the users of a workspace of the workspace with the ID '12345678-1234-1234-1234-123456789012'. -This example retrieves the users of a workspace of the workspace with the ID '12345678-1234-1234-1234-123456789012'. + ```powershell + Get-FabricWorkspaceUser -WorkspaceId '12345678-1234-1234-1234-123456789012 + ``` .EXAMPLE -$workspace = Get-FabricWorkspace -WorkspaceName 'prod-workspace' -$workspace | Get-FabricWorkspaceUser + This example retrieves the users of the prod-workspace workspace by piping the object. -This example retrieves the users of the prod-workspace workspace by piping the object. + ```powershell + $workspace = Get-FabricWorkspace -WorkspaceName 'prod-workspace' + + $workspace | Get-FabricWorkspaceUser + ``` .EXAMPLE -Get-FabricWorkspaceUser -Workspace (Get-FabricWorkspace -WorkspaceName 'prod-workspace') + This example retrieves the users of the prod-workspace workspace by piping the object. -This example retrieves the users of the prod-workspace workspace by piping the object. + ```powershell + Get-FabricWorkspaceUser -Workspace (Get-FabricWorkspace -WorkspaceName 'prod-workspace') + ``` .EXAMPLE -Get-FabricWorkspace| Get-FabricWorkspaceUser + This example retrieves the users of all of the workspaces. IMPORTANT: This will not return the workspace name or ID at present. -This example retrieves the users of all of the workspaces. IMPORTANT: This will not return the workspace name or ID at present. + ```powershell + Get-FabricWorkspace| Get-FabricWorkspaceUser + ``` .EXAMPLE -Get-FabricWorkspace| Foreach-Object { -Get-FabricWorkspaceUser -WorkspaceId $_.Id | Select-Object @{Name='WorkspaceName';Expression={$_.displayName;}}, * -} + This example retrieves the users of all of the workspaces and returns the workspace name as well. -This example retrieves the users of all of the workspaces. It will also add the workspace name to the output. + ```powershell + Get-FabricWorkspace| Foreach-Object { + Get-FabricWorkspaceUser -WorkspaceId $_.Id | Select-Object @{Name='WorkspaceName';Expression={$_.displayName;}}, * + } + ``` .NOTES It supports multiple aliases for backward compatibility. diff --git a/source/Public/Workspace/New-FabricWorkspace.ps1 b/source/Public/Workspace/New-FabricWorkspace.ps1 index 5e6a643c..247df3f6 100644 --- a/source/Public/Workspace/New-FabricWorkspace.ps1 +++ b/source/Public/Workspace/New-FabricWorkspace.ps1 @@ -5,7 +5,7 @@ function New-FabricWorkspace Creates a new Fabric workspace with the specified display name. .DESCRIPTION -The `Add-FabricWorkspace` function creates a new workspace in the Fabric platform by sending a POST request to the API. It validates the display name and handles both success and error responses. +The `New-FabricWorkspace` function creates a new workspace in the Fabric platform by sending a POST request to the API. It validates the display name and handles both success and error responses. .PARAMETER WorkspaceName The display name of the workspace to be created. Must only contain alphanumeric characters, spaces, and underscores. @@ -17,9 +17,11 @@ The display name of the workspace to be created. Must only contain alphanumeric (Optional) The ID of the capacity to be associated with the workspace. This parameter is optional. .EXAMPLE -Add-FabricWorkspace -WorkspaceName "NewWorkspace" + Creates a workspace named "NewWorkspace". -Creates a workspace named "NewWorkspace". + ```powershell + New-FabricWorkspace -WorkspaceName "NewWorkspace" + ``` .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. diff --git a/source/Public/Workspace/New-FabricWorkspaceUsageMetricsReport.ps1 b/source/Public/Workspace/New-FabricWorkspaceUsageMetricsReport.ps1 index ffa06bc0..94f05ccd 100644 --- a/source/Public/Workspace/New-FabricWorkspaceUsageMetricsReport.ps1 +++ b/source/Public/Workspace/New-FabricWorkspaceUsageMetricsReport.ps1 @@ -10,9 +10,11 @@ The New-FabricWorkspaceUsageMetricsReport function retrieves the workspace usage The ID of the workspace. This is a mandatory parameter. .EXAMPLE -New-FabricWorkspaceUsageMetricsReport -workspaceId "your-workspace-id" + This example retrieves the workspace usage metrics dataset ID for a specific workspace given the workspace ID. -This example retrieves the workspace usage metrics dataset ID for a specific workspace given the workspace ID. + ```powershell + New-FabricWorkspaceUsageMetricsReport -workspaceId "your-workspace-id" + ``` .NOTES The function retrieves the PowerBI access token and the Fabric API cluster URI. It then makes a GET request to the Fabric API to retrieve the workspace usage metrics dataset ID, parses the response and replaces certain keys to match the expected format, and returns the 'dbName' property of the first model in the response, which is the dataset ID. diff --git a/source/Public/Workspace/Register-FabricWorkspaceToCapacity.ps1 b/source/Public/Workspace/Register-FabricWorkspaceToCapacity.ps1 index 2e9423be..608516f7 100644 --- a/source/Public/Workspace/Register-FabricWorkspaceToCapacity.ps1 +++ b/source/Public/Workspace/Register-FabricWorkspaceToCapacity.ps1 @@ -16,20 +16,23 @@ The workspace object to be Seted. This is a mandatory parameter and can be piped The ID of the capacity to which the workspace will be Seted. This is a mandatory parameter. .EXAMPLE -Register-FabricWorkspaceToCapacity -WorkspaceId "Workspace-GUID" -CapacityId "Capacity-GUID" + This example Sets the workspace with ID "Workspace-GUID" to the capacity with ID "Capacity-GUID". -This example Sets the workspace with ID "Workspace-GUID" to the capacity with ID "Capacity-GUID". + ```powershell + Register-FabricWorkspaceToCapacity -WorkspaceId "Workspace-GUID" -CapacityId "Capacity-GUID" + ``` .EXAMPLE -$workspace | Register-FabricWorkspaceToCapacity -CapacityId "Capacity-GUID" + This example Sets the workspace object stored in the $workspace variable to the capacity with ID "Capacity-GUID". The workspace object is piped into the function. -This example Sets the workspace object stored in the $workspace variable to the capacity with ID "Capacity-GUID". The workspace object is piped into the function. + ```powershell + $workspace | Register-FabricWorkspaceToCapacity -CapacityId "Capacity-GUID" + ``` .NOTES -The function makes a POST request to the PowerBI API to Set the workspace to the capacity. The PowerBI access token is retrieved using the Get-PowerBIAccessToken function. - -Author: Ioana Bouariu + The function makes a POST request to the PowerBI API to Set the workspace to the capacity. The PowerBI access token is retrieved using the Get-PowerBIAccessToken function. + Author: Ioana Bouariu #> # It supports multiple aliases for flexibility. diff --git a/source/Public/Workspace/Remove-FabricWorkspace.ps1 b/source/Public/Workspace/Remove-FabricWorkspace.ps1 index 883999a1..5af424fe 100644 --- a/source/Public/Workspace/Remove-FabricWorkspace.ps1 +++ b/source/Public/Workspace/Remove-FabricWorkspace.ps1 @@ -1,25 +1,27 @@ -<# -.SYNOPSIS -Deletes an existing Fabric workspace by its workspace ID. +function Remove-FabricWorkspace { + <# + .SYNOPSIS + Deletes an existing Fabric workspace by its workspace ID. -.DESCRIPTION -The `Remove-FabricWorkspace` function deletes a workspace in the Fabric platform by sending a DELETE request to the API. It validates the workspace ID and handles both success and error responses. + .DESCRIPTION + The `Remove-FabricWorkspace` function deletes a workspace in the Fabric platform by sending a DELETE request to the API. It validates the workspace ID and handles both success and error responses. -.PARAMETER WorkspaceId -The unique identifier of the workspace to be deleted. + .PARAMETER WorkspaceId + The unique identifier of the workspace to be deleted. -.EXAMPLE -Remove-FabricWorkspace -WorkspaceId "workspace123" + .EXAMPLE + Deletes the workspace with the ID "workspace123". -Deletes the workspace with the ID "workspace123". + ```powershell + Remove-FabricWorkspace -WorkspaceId "workspace123" + ``` -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -Author: Tiago Balabuch -#> -function Remove-FabricWorkspace { + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Workspace/Remove-FabricWorkspaceCapacityAssignment.ps1 b/source/Public/Workspace/Remove-FabricWorkspaceCapacityAssignment.ps1 index d7624283..17fac719 100644 --- a/source/Public/Workspace/Remove-FabricWorkspaceCapacityAssignment.ps1 +++ b/source/Public/Workspace/Remove-FabricWorkspaceCapacityAssignment.ps1 @@ -1,27 +1,28 @@ -<# -.SYNOPSIS -Unassigns a Fabric workspace from its capacity. - -.DESCRIPTION -The `Remove-FabricWorkspaceCapacityAssignment` function sends a POST request to unassign a workspace from its assigned capacity. +function Remove-FabricWorkspaceCapacityAssignment +{ + <# + .SYNOPSIS + Unassigns a Fabric workspace from its capacity. -.PARAMETER WorkspaceId -The unique identifier of the workspace to be unassigned from its capacity. + .DESCRIPTION + The `Remove-FabricWorkspaceCapacityAssignment` function sends a POST request to unassign a workspace from its assigned capacity. -.EXAMPLE -Remove-FabricWorkspaceCapacityAssignment -WorkspaceId "workspace123" + .PARAMETER WorkspaceId + The unique identifier of the workspace to be unassigned from its capacity. -Unassigns the workspace with ID "workspace123" from its capacity. + .EXAMPLE + Unassign the workspace with ID "workspace123" from its capacity. -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Remove-FabricWorkspaceCapacityAssignment -WorkspaceId "workspace123" + ``` -Author: Tiago Balabuch -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Remove-FabricWorkspaceCapacityAssignment -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] [Alias("Unassign-FabricWorkspaceCapacity")] param ( diff --git a/source/Public/Workspace/Remove-FabricWorkspaceIdentity.ps1 b/source/Public/Workspace/Remove-FabricWorkspaceIdentity.ps1 index 822547e2..cd0dcada 100644 --- a/source/Public/Workspace/Remove-FabricWorkspaceIdentity.ps1 +++ b/source/Public/Workspace/Remove-FabricWorkspaceIdentity.ps1 @@ -1,27 +1,28 @@ -<# -.SYNOPSIS -Deprovisions the Managed Identity for a specified Fabric workspace. - -.DESCRIPTION -The `Remove-FabricWorkspaceCapacity` function deprovisions the Managed Identity from the given workspace by calling the appropriate API endpoint. +function Remove-FabricWorkspaceIdentity +{ + <# + .SYNOPSIS + Deprovisions the Managed Identity for a specified Fabric workspace. -.PARAMETER WorkspaceId -The unique identifier of the workspace from which the identity will be removed. + .DESCRIPTION + The `Remove-FabricWorkspaceCapacity` function deprovisions the Managed Identity from the given workspace by calling the appropriate API endpoint. -.EXAMPLE -Remove-FabricWorkspaceCapacity -WorkspaceId "workspace123" + .PARAMETER WorkspaceId + The unique identifier of the workspace from which the identity will be removed. -Deprovisions the Managed Identity for the workspace with ID "workspace123". + .EXAMPLE + Deprovisions the Managed Identity for the workspace with ID "workspace123". -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Remove-FabricWorkspaceCapacity -WorkspaceId "workspace123" + ``` -Author: Tiago Balabuch -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Remove-FabricWorkspaceIdentity -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Workspace/Remove-FabricWorkspaceRoleAssignment.ps1 b/source/Public/Workspace/Remove-FabricWorkspaceRoleAssignment.ps1 index 04410a6c..a97e9eb6 100644 --- a/source/Public/Workspace/Remove-FabricWorkspaceRoleAssignment.ps1 +++ b/source/Public/Workspace/Remove-FabricWorkspaceRoleAssignment.ps1 @@ -1,31 +1,31 @@ -<# -.SYNOPSIS -Removes a role assignment from a Fabric workspace. - -.DESCRIPTION -The `Remove-FabricWorkspaceRoleAssignment` function deletes a specific role assignment from a Fabric workspace by making a DELETE request to the API. - -.PARAMETER WorkspaceId -The unique identifier of the workspace. +function Remove-FabricWorkspaceRoleAssignment +{ + <# + .SYNOPSIS + Removes a role assignment from a Fabric workspace. -.PARAMETER WorkspaceRoleAssignmentId -The unique identifier of the role assignment to be removed. + .DESCRIPTION + The `Remove-FabricWorkspaceRoleAssignment` function deletes a specific role assignment from a Fabric workspace by making a DELETE request to the API. -.EXAMPLE -Remove-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "role123" + .PARAMETER WorkspaceId + The unique identifier of the workspace. -Removes the role assignment with the ID "role123" from the workspace "workspace123". + .PARAMETER WorkspaceRoleAssignmentId + The unique identifier of the role assignment to be removed. -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + .EXAMPLE + Removes the role assignment with the ID "role123" from the workspace "workspace123". -Author: Tiago Balabuch + ```powershell + Remove-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "role123" + ``` -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Remove-FabricWorkspaceRoleAssignment -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Workspace/Unregister-FabricWorkspaceToCapacity.ps1 b/source/Public/Workspace/Unregister-FabricWorkspaceToCapacity.ps1 index 08849d4d..935fd093 100644 --- a/source/Public/Workspace/Unregister-FabricWorkspaceToCapacity.ps1 +++ b/source/Public/Workspace/Unregister-FabricWorkspaceToCapacity.ps1 @@ -1,37 +1,37 @@ -<# -.SYNOPSIS -Unregisters a workspace from a capacity. - -.DESCRIPTION -The Unregister-FabricWorkspaceToCapacity function unregisters a workspace from a capacity in PowerBI. It can be used to remove a workspace from a capacity, allowing it to be assigned to a different capacity or remain unassigned. - -.PARAMETER WorkspaceId -Specifies the ID of the workspace to be unregistered from the capacity. This parameter is mandatory when using the 'WorkspaceId' parameter set. +function Unregister-FabricWorkspaceToCapacity { + <# + .SYNOPSIS + Unregisters a workspace from a capacity. -.PARAMETER Workspace -Specifies the workspace object to be unregistered from the capacity. This parameter is mandatory when using the 'WorkspaceObject' parameter set. The workspace object can be piped into the function. + .DESCRIPTION + The Unregister-FabricWorkspaceToCapacity function unregisters a workspace from a capacity in PowerBI. It can be used to remove a workspace from a capacity, allowing it to be assigned to a different capacity or remain unassigned. -.EXAMPLE -Unregister-FabricWorkspaceToCapacity -WorkspaceId "12345678" -Unregisters the workspace with ID "12345678" from the capacity. + .PARAMETER WorkspaceId + Specifies the ID of the workspace to be unregistered from the capacity. This parameter is mandatory when using the 'WorkspaceId' parameter set. -.EXAMPLE -Get-FabricWorkspace | Unregister-FabricWorkspaceToCapacity -Unregisters the workspace objects piped from Get-FabricWorkspace from the capacity. + .PARAMETER Workspace + Specifies the workspace object to be unregistered from the capacity. This parameter is mandatory when using the 'WorkspaceObject' parameter set. The workspace object can be piped into the function. -.INPUTS -System.Management.Automation.PSCustomObject + .EXAMPLE + Unregisters the workspace with ID "12345678" from the capacity. -.OUTPUTS -System.Object + ```powershell + Unregister-FabricWorkspaceToCapacity -WorkspaceId "12345678" + ``` -.NOTES + .EXAMPLE + Unregisters the workspace objects piped from Get-FabricWorkspace from the capacity. .INPUTS System.Management.Automation.PSCustomObject -Author: Ioana Bouariu + ```powershell + Get-FabricWorkspace | Unregister-FabricWorkspaceToCapacity + ``` -#> + .OUTPUTS + System.Object -function Unregister-FabricWorkspaceToCapacity { + .NOTES + Author: Ioana Bouariu + #> [Alias("Unregister-FabWorkspaceToCapacity")] [CmdletBinding(SupportsShouldProcess)] param( diff --git a/source/Public/Workspace/Update-FabricWorkspace.ps1 b/source/Public/Workspace/Update-FabricWorkspace.ps1 index 0b421675..466d5f02 100644 --- a/source/Public/Workspace/Update-FabricWorkspace.ps1 +++ b/source/Public/Workspace/Update-FabricWorkspace.ps1 @@ -1,38 +1,41 @@ -<# -.SYNOPSIS -Updates the properties of a Fabric workspace. - -.DESCRIPTION -The `Update-FabricWorkspace` function updates the name and/or description of a specified Fabric workspace by making a PATCH request to the API. +function Update-FabricWorkspace +{ + <# + .SYNOPSIS + Updates the properties of a Fabric workspace. -.PARAMETER WorkspaceId -The unique identifier of the workspace to be updated. + .DESCRIPTION + The `Update-FabricWorkspace` function updates the name and/or description of a specified Fabric workspace by making a PATCH request to the API. -.PARAMETER WorkspaceName -The new name for the workspace. + .PARAMETER WorkspaceId + The unique identifier of the workspace to be updated. -.PARAMETER WorkspaceDescription -(Optional) The new description for the workspace. + .PARAMETER WorkspaceName + The new name for the workspace. -.EXAMPLE -Update-FabricWorkspace -WorkspaceId "workspace123" -WorkspaceName "NewWorkspaceName" + .PARAMETER WorkspaceDescription + (Optional) The new description for the workspace. -Updates the name of the workspace with the ID "workspace123" to "NewWorkspaceName". + .EXAMPLE + Updates the name of the workspace with the ID "workspace123" to "NewWorkspaceName". -.EXAMPLE -Update-FabricWorkspace -WorkspaceId "workspace123" -WorkspaceName "NewName" -WorkspaceDescription "Updated description" + ```powershell + Update-FabricWorkspace -WorkspaceId "workspace123" -WorkspaceName "NewWorkspaceName" + ``` -Updates both the name and description of the workspace "workspace123". + .EXAMPLE + Updates both the name and description of the workspace "workspace123". -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + ```powershell + Update-FabricWorkspace -WorkspaceId "workspace123" -WorkspaceName "NewName" -WorkspaceDescription "Updated description" + ``` -Author: Tiago Balabuch -#> + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -function Update-FabricWorkspace -{ + Author: Tiago Balabuch + #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/source/Public/Workspace/Update-FabricWorkspaceRoleAssignment.ps1 b/source/Public/Workspace/Update-FabricWorkspaceRoleAssignment.ps1 index aa7d2cb8..7a6b9b3c 100644 --- a/source/Public/Workspace/Update-FabricWorkspaceRoleAssignment.ps1 +++ b/source/Public/Workspace/Update-FabricWorkspaceRoleAssignment.ps1 @@ -1,37 +1,38 @@ -<# -.SYNOPSIS -Updates the role assignment for a specific principal in a Fabric workspace. +function Update-FabricWorkspaceRoleAssignment +{ + <# + .SYNOPSIS + Updates the role assignment for a specific principal in a Fabric workspace. -.DESCRIPTION -The `Update-FabricWorkspaceRoleAssignment` function updates the role assigned to a principal in a workspace by making a PATCH request to the API. + .DESCRIPTION + The `Update-FabricWorkspaceRoleAssignment` function updates the role assigned to a principal in a workspace by making a PATCH request to the API. -.PARAMETER WorkspaceId -The unique identifier of the workspace where the role assignment exists. + .PARAMETER WorkspaceId + The unique identifier of the workspace where the role assignment exists. -.PARAMETER WorkspaceRoleAssignmentId -The unique identifier of the role assignment to be updated. + .PARAMETER WorkspaceRoleAssignmentId + The unique identifier of the role assignment to be updated. -.PARAMETER WorkspaceRole -The new role to assign to the principal. Must be one of the following: -- Admin -- Contributor -- Member -- Viewer + .PARAMETER WorkspaceRole + The new role to assign to the principal. Must be one of the following: + - Admin + - Contributor + - Member + - Viewer -.EXAMPLE -Update-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "assignment456" -WorkspaceRole "Admin" + .EXAMPLE + Updates the role assignment to "Admin" for the specified workspace and role assignment. -Updates the role assignment to "Admin" for the specified workspace and role assignment. + ```powershell + Update-FabricWorkspaceRoleAssignment -WorkspaceId "workspace123" -WorkspaceRoleAssignmentId "assignment456" -WorkspaceRole "Admin" + ``` -.NOTES -- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. -- Calls `Confirm-TokenState` to ensure token validity before making the API request. + .NOTES + - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. + - Calls `Confirm-TokenState` to ensure token validity before making the API request. -Author: Tiago Balabuch + Author: Tiago Balabuch #> - -function Update-FabricWorkspaceRoleAssignment -{ [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory = $true)] diff --git a/tests/Unit/Get-FabricContinuationToken.Tests.ps1 b/tests/Unit/Get-FabricContinuationToken.Tests.ps1 index 23e03333..bf05a021 100644 --- a/tests/Unit/Get-FabricContinuationToken.Tests.ps1 +++ b/tests/Unit/Get-FabricContinuationToken.Tests.ps1 @@ -1,50 +1,47 @@ #Requires -Module @{ ModuleName="Pester"; ModuleVersion="5.0"} InModuleScope FabricTools { - -param( - $ModuleName = "FabricTools", - $expectedParams = @( - "Response" - "Verbose" - "Debug" - "ErrorAction" - "WarningAction" - "InformationAction" - "ProgressAction" - "ErrorVariable" - "WarningVariable" - "InformationVariable" - "OutVariable" - "OutBuffer" - "PipelineVariable" + param( + $ModuleName = "FabricTools", + $expectedParams = @( + "Response" + "Verbose" + "Debug" + "ErrorAction" + "WarningAction" + "InformationAction" + "ProgressAction" + "ErrorVariable" + "WarningVariable" + "InformationVariable" + "OutVariable" + "OutBuffer" + "PipelineVariable" + ) ) -) - -Describe "Get-FabricContinuationToken" -Tag "UnitTests" { - BeforeDiscovery { - ipmo ".\output\module\FabricTools\0.0.1\FabricTools.psd1" + Describe "Get-FabricContinuationToken" -Tag "UnitTests" { - $command = Get-Command -Name Get-FabricContinuationToken - $script:expected = $expectedParams - } + BeforeDiscovery { - Context "Parameter validation" { - BeforeAll { $command = Get-Command -Name Get-FabricContinuationToken - $expected = $expectedParams + $script:fabricTokenParams = $expectedParams } - It "Has parameter: <_>" -ForEach $expected { - $command | Should -HaveParameter $PSItem - } + Context "Parameter validation" { + BeforeAll { + $command = Get-Command -Name Get-FabricContinuationToken + $expected = $expectedParams + } - It "Should have exactly the number of expected parameters $($expected.Count)" { - $hasParams = $command.Parameters.Values.Name - Compare-Object -ReferenceObject $script:expected -DifferenceObject $hasParams | Should -BeNullOrEmpty + It "Has parameter: <_>" -ForEach $expected { + $command | Should -HaveParameter $PSItem + } + + It "Should have exactly the number of expected parameters $($expected.Count)" { + $hasParams = $command.Parameters.Values.Name + Compare-Object -ReferenceObject $script:fabricTokenParams -DifferenceObject $hasParams | Should -BeNullOrEmpty + } } } } - -}