src/Solutions/Metadata/Tables/Set-XrmTable.ps1
|
<# .SYNOPSIS Update a table in Microsoft Dataverse. .DESCRIPTION Update an existing entity / table metadata using UpdateEntityRequest. .PARAMETER XrmClient Xrm connector initialized to target instance. Use latest one by default. (Dataverse ServiceClient) .PARAMETER MetadataId The MetadataId (GUID) of the table to update. .PARAMETER DisplayName New display name for the table. .PARAMETER DisplayCollectionName New plural display name for the table. .PARAMETER OwnershipType Ownership type (UserOwned or OrganizationOwned). .PARAMETER IsActivity Whether the table is an activity entity. .PARAMETER HasNotes Whether the table has notes enabled. .PARAMETER HasActivities Whether the table has activities enabled. .PARAMETER IsAuditEnabled Whether auditing is enabled on the table. .PARAMETER SolutionUniqueName Solution unique name context for the update. .PARAMETER MergeLabels Whether to merge labels. Default: true. .PARAMETER LanguageCode Language code for labels. Default: 1033. .OUTPUTS Microsoft.Xrm.Sdk.OrganizationResponse. The UpdateEntity response. .EXAMPLE Set-XrmTable -MetadataId "00000000-0000-0000-0000-000000000001" -DisplayName "Customer" -DisplayCollectionName "Customers"; #> function Set-XrmTable { [CmdletBinding()] [OutputType([Microsoft.Xrm.Sdk.OrganizationResponse])] param ( [Parameter(Mandatory = $false, ValueFromPipeline)] [Microsoft.PowerPlatform.Dataverse.Client.ServiceClient] $XrmClient = $Global:XrmClient, [Parameter(Mandatory = $true)] [ValidateNotNull()] [guid] $MetadataId, [Parameter(Mandatory = $false)] [string] $DisplayName, [Parameter(Mandatory = $false)] [string] $DisplayCollectionName, [Parameter(Mandatory = $false)] [Microsoft.Xrm.Sdk.Metadata.OwnershipTypes] $OwnershipType, [Parameter(Mandatory = $false)] [bool] $IsActivity, [Parameter(Mandatory = $false)] [bool] $HasNotes, [Parameter(Mandatory = $false)] [bool] $HasActivities, [Parameter(Mandatory = $false)] [bool] $IsAuditEnabled, [Parameter(Mandatory = $false)] [string] $SolutionUniqueName, [Parameter(Mandatory = $false)] [bool] $MergeLabels = $true, [Parameter(Mandatory = $false)] [int] $LanguageCode = 1033 ) begin { $StopWatch = [System.Diagnostics.Stopwatch]::StartNew(); Trace-XrmFunction -Name $MyInvocation.MyCommand.Name -Stage Start -Parameters ($MyInvocation.MyCommand.Parameters); } process { $entityMetadata = [Microsoft.Xrm.Sdk.Metadata.EntityMetadata]::new(); $entityMetadata.MetadataId = $MetadataId; if ($PSBoundParameters.ContainsKey('DisplayName')) { $entityMetadata.DisplayName = New-XrmLabel -Text $DisplayName -LanguageCode $LanguageCode; } if ($PSBoundParameters.ContainsKey('DisplayCollectionName')) { $entityMetadata.DisplayCollectionName = New-XrmLabel -Text $DisplayCollectionName -LanguageCode $LanguageCode; } if ($PSBoundParameters.ContainsKey('OwnershipType')) { $entityMetadata.OwnershipType = $OwnershipType; } if ($PSBoundParameters.ContainsKey('IsActivity')) { $entityMetadata.IsActivity = $IsActivity; } if ($PSBoundParameters.ContainsKey('HasNotes')) { $entityMetadata.HasNotes = $HasNotes; } if ($PSBoundParameters.ContainsKey('HasActivities')) { $entityMetadata.HasActivities = $HasActivities; } if ($PSBoundParameters.ContainsKey('IsAuditEnabled')) { $entityMetadata.IsAuditEnabled = [Microsoft.Xrm.Sdk.BooleanManagedProperty]::new($IsAuditEnabled); } $request = [Microsoft.Xrm.Sdk.Messages.UpdateEntityRequest]::new(); $request.Entity = $entityMetadata; $request.MergeLabels = $MergeLabels; if ($PSBoundParameters.ContainsKey('SolutionUniqueName')) { $request.Parameters["SolutionUniqueName"] = $SolutionUniqueName; } $response = Invoke-XrmRequest -XrmClient $XrmClient -Request $request; $response; } end { $StopWatch.Stop(); Trace-XrmFunction -Name $MyInvocation.MyCommand.Name -Stage Stop -StopWatch $StopWatch; } } Export-ModuleMember -Function Set-XrmTable -Alias *; |