functions/Get-BapEnvironmentVirtualEntity.ps1
|
<# .SYNOPSIS Get Virtual Entity from environment .DESCRIPTION Enables the user to query against the Virtual Entities from the D365FO environment This will help determine which Virtual Entities are already enabled / visible and their state, as they are seeing from the Dataverse environment .PARAMETER EnvironmentId The id of the environment that you want to work against .PARAMETER Name The name of the virtual entity that you are looking for The parameter supports wildcards, but will resolve them into a strategy that matches best practice from Microsoft documentation It means that you can only have a single search phrase. E.g. * -Name "*Retail" * -Name "Retail*" * -Name "*Retail*" Multiple search phrases are not going to produce an output, as it will be striped into an invalid search string. E.g. ! -Name "*Retail*Entity*" -> "RetailEntity" ! -Name "Retail*Entity" -> "RetailEntity" ! -Name "*Retail*Entity" -> "RetailEntity" ! -Name "Retail*Entity*" -> "RetailEntity" .PARAMETER VisibleOnly Instruct the cmdlet to only output those virtual entities that are enabled / visible .PARAMETER AsExcelOutput Instruct the cmdlet to output all details directly to an Excel file This makes it easier to deep dive into all the details returned from the API, and makes it possible for the user to persist the current state .EXAMPLE PS C:\> Get-BapEnvironmentVirtualEntity -EnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 This will fetch all virtual entities from the environment. Sample output: EntityName IsVisible ChangeTrackingEnabled EntityGuid ---------- --------- --------------------- ---------- AadWorkerIntegrationEntity False False 00002893-0000-0000-560a-005001000000 AbbreviationsEntity False False 00002893-0000-0000-5002-005001000000 AccountantEntity False False 00002893-0000-0000-0003-005001000000 AccountingDistributionBiEntity False False 00002893-0000-0000-d914-005001000000 AccountingEventBiEntity False False 00002893-0000-0000-d414-005001000000 .EXAMPLE PS C:\> Get-BapEnvironmentVirtualEntity -EnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 -VisibleOnly This will fetch visble only virtual entities from the environment. Sample output: EntityName IsVisible ChangeTrackingEnabled EntityGuid ---------- --------- --------------------- ---------- CurrencyEntity True False 00002893-0000-0000-c30b-005001000000 WMHEOutboundQueueEntity True False 00002893-0000-0000-f30b-005001000000 .EXAMPLE PS C:\> Get-BapEnvironmentVirtualEntity -EnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 -AsExcelOutput This will fetch all virtual entities from the environment. Will output all details into an Excel file, that will auto open on your machine. .EXAMPLE PS C:\> Get-BapEnvironmentVirtualEntity -EnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 -Name "Retail*" This will fetch all virtual entities that contains the "Retail" text in the name, from the environment. Sample output: EntityName IsVisible ChangeTrackingEnabled EntityGuid ---------- --------- --------------------- ---------- CustHierarchyRetailChannelEnt… False False 00002893-0000-0000-e314-005001000000 DimAttributeRetailChannelEnti… False False 00002893-0000-0000-0804-005001000000 DimAttributeRetailStoreEntity False False 00002893-0000-0000-0f03-005001000000 DimAttributeRetailTerminalEnt… False False 00002893-0000-0000-6e07-005001000000 EcoResRetailProductEntity False False 00002893-0000-0000-ae06-005001000000 .EXAMPLE PS C:\> Get-BapEnvironmentVirtualEntity -EnvironmentId eec2c11a-a4c7-4e1d-b8ed-f62acc9c74c6 -Name AccountantEntity This will fetch the specific virtual entity from the environment. Sample output: EntityName IsVisible ChangeTrackingEnabled EntityGuid ---------- --------- --------------------- ---------- AccountantEntity False False 00002893-0000-0000-0003-005001000000 .NOTES Author: Mötz Jensen (@Splaxi) #> function Get-BapEnvironmentVirtualEntity { [CmdletBinding()] [OutputType('System.Object[]')] param ( [parameter (mandatory = $true)] [string] $EnvironmentId, [string] $Name = "*", [switch] $VisibleOnly, [switch] $AsExcelOutput ) begin { # Make sure all *BapEnvironment* cmdlets will validate that the environment exists prior running anything. $envObj = Get-BapEnvironment -EnvironmentId $EnvironmentId | Select-Object -First 1 if ($null -eq $envObj) { $messageString = "The supplied EnvironmentId: <c='em'>$EnvironmentId</c> didn't return any matching environment details. Please verify that the EnvironmentId is correct - try running the <c='em'>Get-BapEnvironment</c> cmdlet." Write-PSFMessage -Level Host -Message $messageString Stop-PSFFunction -Message "Stopping because environment was NOT found based on the id." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) } if (Test-PSFFunctionInterrupt) { return } $baseUri = $envObj.LinkedMetaPpacEnvUri $tokenWebApi = Get-AzAccessToken -ResourceUrl $baseUri $headersWebApi = @{ "Authorization" = "Bearer $($tokenWebApi.Token)" } # Fetch all meta data - for all entities in the environment $entitiesMetaRaw = Invoke-RestMethod -Method Get -Uri $($baseUri + '/api/data/v9.2/entities') -Headers $headersWebApi $templateMeta = $entitiesMetaRaw.value[0] # Filter down to only those who are connected to Virtual Entities $entitiesMeta = $entitiesMetaRaw.value | Where-Object { -not [System.String]::IsNullOrEmpty($_.externalname) } } process { if (Test-PSFFunctionInterrupt) { return } $localUri = $($baseUri + '/api/data/v9.2/mserp_financeandoperationsentities') [System.Collections.Generic.List[System.String]]$filters = @() # Is the user search for specific entities? if ($Name -ne "*") { if ($Name.IndexOfAny("*") -gt -1) { # It is a wildcard search $filters.Add("contains(mserp_physicalname, '$($Name.Replace('*',''))')") } else { # It is a full named search $filters.Add("mserp_physicalname eq '$Name'") } } if ($VisibleOnly) { $filters.Add("mserp_hasbeengenerated eq true") } if ($filters.count -gt 0) { # We need to handle multiple filters $localUri += '?$filter=' $localUri += $($filters.ToArray() -join " and ") } $resEntities = Invoke-RestMethod -Method Get -Uri $localUri -Headers $headersWebApi $resCol = @( foreach ($virEntity in $($resEntities.value | Sort-Object -Property mserp_physicalname)) { $tempMeta = $entitiesMeta | Where-Object externalname -eq $virEntity.mserp_physicalname | Select-Object -First 1 if ($null -ne $tempMeta) { # Work against the meta data found foreach ($prop in $tempMeta.PsObject.Properties) { $virEntity | Add-Member -MemberType NoteProperty -Name "meta_$($prop.Name)" -Value $prop.Value } } else { # Create empty properties for those who doesn't have meta data available foreach ($prop in $templateMeta.PsObject.Properties) { $virEntity | Add-Member -MemberType NoteProperty -Name "meta_$($prop.Name)" -Value $null } } $virEntity | Select-PSFObject -TypeName "D365Bap.Tools.VirtualEntity" -Property "mserp_physicalname as EntityName", "mserp_hasbeengenerated as IsVisible", "mserp_changetrackingenabled as ChangeTrackingEnabled", "mserp_financeandoperationsentityid as EntityGuid", * } ) if ($AsExcelOutput) { $resCol | Export-Excel return } $resCol } end { } } |