FabricTools v0.33.0 Public Preview

Update-FabricDomain

Updates a Fabric domain by its ID.

Syntax

Update-FabricDomain [-DomainId] <guid> [-DomainName] <string> [[-DomainDescription] <string>]
 [[-DomainContributorsScope] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

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.

Update-FabricDomain -DomainId "12345" -DomainName "NewDomain" -DomainDescription "Updated description" -DomainContributorsScope "AdminsOnly"

Parameters

NameTypeReq.Pos.PipelineDescription
-DomainId guid ✓Required 0 –

The unique identifier of the domain to be updated.

-DomainName string ✓Required 1 –

The new name for the domain. Must be alphanumeric.

-Confirmalias: cf switch Named –

Prompts you for confirmation before running the cmdlet.

-DomainContributorsScope string 3 –

(Optional) The contributors' scope for the domain. Accepted values: 'AdminsOnly', 'AllTenant', 'SpecificUsersAndGroups'.

-DomainDescription string 2 –

(Optional) A new description for the domain.

-WhatIfalias: wi switch Named –

Runs the command in a mode that only reports what would happen without performing the actions.

This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.

Notes

  • Calls Confirm-TokenState to ensure token validity before making the API request.

Author: Tiago Balabuch, Kamil Nowinski