-
Notifications
You must be signed in to change notification settings - Fork 0
Namespaces
Also known as abbreviations or command groups. See also Abbreviations.
d365bap.tools is aiming to make the life easier, for anyone that has to manage the Dynamics 365 ERP suite and PPAC.
Because many different concepts are in play, we are using the following abbreviations as part of the noun of each command (e.g. Get-PpacUser, Get-FscmUser).
The tables below are generated automatically from the comment based help of each command, and are kept up to date by build/update-docs.ps1.
If you want to generate the list yourself, use the following PowerShell command (replace Ppac with the namespace you are interested in):
Get-Command -Module d365bap.tools -Noun Ppac*Business Application Platform - AKA - Bap
This is for the things that span across the Business Application Platform itself, like tenants and the environments hosted on it (e.g. linking, comparing and installing D365 apps). his is also the oldest namespace, back when d365bap.tools only used this namespace. As such, it contains a few c"other" commands that have nothing to do with the Business Application Plat T
| Command | Description |
|---|---|
| Compare-BapEnvironmentD365App | Compare environment D365 Apps |
| Compare-BapEnvironmentUser | Compare the environment users |
| Compare-BapEnvironmentVirtualEntity | Compare environment Virtual Entities |
| Confirm-BapEnvironmentIntegration | Test the integration status |
| Get-BapEnvironment | Retrieves information about Power Platform environments. |
| Get-BapEnvironmentApplicationUser | Get application users from environment |
| Get-BapEnvironmentD365App | Get D365 App from the environment |
| Get-BapEnvironmentLinkEnterprisePolicy | Get Enterprise Policy |
| Get-BapEnvironmentOperation | Get environment life cycle operation info |
| Get-BapEnvironmentPowerApp | Get PowerApps from environment |
| Get-BapEnvironmentUser | Get users from environment |
| Get-BapEnvironmentVirtualEntity | Get Virtual Entity from environment |
| Get-BapTenant | Retrieves information about the available azure tenant. |
| Get-BapTenantDetail | Gets detailed information about a BAP tenant. |
| Invoke-BapEnvironmentInstallD365App | Invoke the installation of a D365 App in a given environment |
| Invoke-BapInstallAzCopy | Installs AzCopy by downloading it from the official Microsoft URL. |
| Remove-BapTenantDetail | Removes tenant details for a specified BAP tenant from the local configuration. |
| Set-BapAzCopyPath | Sets the path to the AzCopy executable. |
| Set-BapEnvironmentLinkEnterprisePolicy | Set the link between Dataverse and the Enterprise Policy |
| Set-BapEnvironmentVirtualEntity | Set Virtual Entity configuration in environment |
| Set-BapTenantDetail | Sets the details for a specific tenant. |
| Switch-BapTenant | Switches the current context to a specified BAP tenant. |
| Update-BapEnvironmentVirtualEntityMetadata | Update the meta data for an Virtual Entity in an environment |
Power Platform Admin Center - AKA - Ppac
This is for all the things that one would normal do from the PPAC portal.
| Command | Description |
|---|---|
| Add-PpacAdminManagementApplication | Add application to the list of admin management applications in Power Platform Admin Center (PPAC). |
| Add-PpacApplicationUser | Add application user to Power Platform environment. |
| Add-PpacRbacRoleMember | Add a service principal as a member of a PPAC RBAC role in a specific scope. |
| Add-PpacSecurityRoleMember | Enables assignment of a user to a security role in the Power Platform environment. |
| Add-PpacTeamOnSecurityGroup | Enables assignment of a Microsoft Entra ID security group as a team in the Power Platform environment. |
| Add-PpacUser | Add a user to a Power Platform environment. |
| Get-PpacAdminManagementApplication | Retrieves information about the Power Platform Admin Management Application(s) |
| Get-PpacApplicationUser | Get application users in Power Platform environment. |
| Get-PpacD365App | Get D365 application that are available in the environment. |
| Get-PpacD365OperationHistory | Get operation history for a given Unified environment from PPAC. |
| Get-PpacD365PlatformUpdate | Get D365 platform update information for the environment. |
| Get-PpacDeployLocation | Get the available deployment locations for Power Platform environments. |
| Get-PpacEnvironmentGroup | Retrieves Power Platform environment groups. |
| Get-PpacRbacRole | Get PPAC RBAC roles available in the tenant. |
| Get-PpacRbacRoleMember | Get members of PPAC RBAC roles in the tenant. |
| Get-PpacSecurityRole | Get information about Power Platform security roles in a given environment. |
| Get-PpacSecurityRoleMember | Get information about Finance and Operations security role members in a given environment. |
| Get-PpacSecurityRoleTable | Get the tables assigned to a security role in a given environment. |
| Get-PpacTable | Get the tables (entities) from a given environment. |
| Get-PpacTeam | Get team details from Power Platform environment. |
| Get-PpacUser | Get information about users in a Power Platform environment. |
| Invoke-PpacD365AppInstall | Installs D365 applications in the environment. |
| Invoke-PpacD365PlatformUpdate | Start D365 Platform update. |
| New-PpacSecurityRole | Create a new security role in a given environment. |
| Remove-PpacUser | Remove a user from a Power Platform environment. |
| Set-PpacAdminMode | Set the admin mode for a Power Platform environment. |
| Set-PpacRbacContext | Authenticate for PPAC RBAC operations by obtaining an access token using user credentials. |
| Set-PpacSecurityGroup | Set or remove Security Group for a Power Platform environment |
| Set-PpacSecurityRoleTable | Set the table privileges of a security role in a given environment. |
| Set-PpacTeamSecurityRole | Set Security Role for a team in a Power Platform environment. |
Finance & Operations / Supply Chain Management - AKA - Fscm
This is when one is working directly against the Dynamics 365 ERP environment. Here we are using the OData or REST Services, that are being exposed.
| Command | Description |
|---|---|
| Add-FscmEntraApplication | Add a registered Entra (AAD) application to a Finance and Operations environment. |
| Add-FscmSecurityRoleMember | Enables assignment of a user to a security role in the Dynamics 365 ERP environment. |
| Add-FscmUser | Add a user to a Finance and Operations environment and assign them a security role. |
| Add-FscmUserFromSecurityGroup | Enables creation of users from an Entra Security Group in the Dynamics 365 ERP environment. |
| Get-FscmDmfEntity | Get DMF entity metadata from a Finance and Operations environment. |
| Get-FscmEntraApplication | Get Entra (AAD) registered applications from a Finance and Operations environment. |
| Get-FscmOdata | Query an OData entity from a Finance and Operations environment. |
| Get-FscmOdataEntity | Get OData entity metadata from a Finance and Operations environment. |
| Get-FscmOdataToken | Get an OData access token for a Finance and Operations environment. |
| Get-FscmRestService | Get REST service metadata from a Finance and Operations environment. |
| Get-FscmSecurityRole | Get information about Finance and Operations security roles in a given environment. |
| Get-FscmSecurityRoleMember | Get information about Finance and Operations security role members in a given environment. |
| Get-FscmUser | Get information about Finance and Operations users in a given environment. |
| Invoke-FscmDmfEntityMetadataRefresh | Refresh all Data Management Framework entity metadata in a Finance and Operations environment. |
| Invoke-FscmRestService | Invokes a REST service operation in Finance and Supply Chain Management (FSCM). |
| Remove-FscmUser | Remove a user from a Finance and Operations environment. |
| Set-FscmUserAccess | Enable or disable user access in a Dynamics 365 Finance & Operations environment |
Power Platform Environment - AKA - Ppe
This is when one is working with concepts that one would normally do via the make.powerplatform.com portal.
| Command | Description |
|---|---|
| Add-PpePublisher | Add a publisher to a Power Platform environment. |
| Add-PpeSolution | Add a solution to a Power Platform environment. |
| Get-PpeCustomApi | Get custom APIs from a Power Platform / Dataverse environment. |
| Get-PpeOdata | Query an OData entity from a Power Platform / Dataverse environment. |
| Get-PpeOdataEntity | Get OData entity metadata from a Power Platform / Dataverse environment. |
| Get-PpePublisher | Get publishers from Power Platform environment. |
| Get-PpeSolution | Get solutions from Power Platform environment. |
| Get-PpeSolutionHistory | Get solution history from Power Platform environment. |
| Invoke-PpePublishAllCustomizations | Start the publish all customizations process for a given environment. |
| Remove-PpeSolution | Remove solutions from a Power Platform environment. |
Unified Developer Experience - AKA - Ude
This is when one is working, either as a developer against an Ude environment or an admin, that manages Ude's for people.
| Command | Description |
|---|---|
| Add-UdeWindowsDefenderRules | Adds Windows Defender exclusion rules for UDE development tools and environments. |
| Clear-UdeCredentialCache | Clears the cached credentials used by Visual Studio for connecting to Dynamics 365 / Power Platform environments. |
| Clear-UdeDbJitCache | Clears the JIT cache for the UDE database. |
| Clear-UdeOrphanedConfig | Clears orphaned UDE configurations and their associated resources. |
| Confirm-UdeVs2022Installation | Confirms the installation of Visual Studio 2022. |
| Export-UdeModelLabel | Exports UDE model label files from PackagesLocalDirectory |
| Get-UdeConfig | Gets UDE configuration information. |
| Get-UdeConnection | Retrieves the UDE connection information. |
| Get-UdeCredentialCache | Gets UDE credential cache information. |
| Get-UdeDbJit | Gets UDE database JIT access information for a specified environment. |
| Get-UdeDbJitCache | Retrieves UDE database JIT access credentials from the local cache. |
| Get-UdeDeveloperFile | Gets UDE developer files for a specified environment. |
| Get-UdeEnvironmentModel | Get UDE environment models. |
| Get-UdeNuget | Gets UDE NuGet packages for a specified environment. |
| Get-UdePackageLocalDirectory | Gets local UDE PackagesLocalDirectory paths |
| Get-UdeVsPackageDeploy | Get UDE VS package deploys. |
| Get-UdeVsPowerPlatformExtensionHistory | Get UDE VS Power Platform extension history. |
| Get-UdeXrefDb | Gets UDE cross-reference databases. |
| Remove-UdeEnvironmentModel | Remove models from a unified environment. |
| Set-UdeConfig | Sets UDE configuration for a specific environment. |
| Set-UdeDbJitCache | Sets UDE database JIT access credentials in the local cache. |
| Set-UdeEnvironmentInSession | Sets the UDE environment in the current PowerShell session. |
| Start-UdeDatabaseRefresh | Start a database refresh between two environments |
| Start-UdeDbSsms | Starts SQL Server Management Studio (SSMS) with the specified JIT access credentials. |
Unified Environment - AKA - Unified
This is for the things that concern the underlying Unified (Developer / Sandbox / Production) environment that a D365 Finance and Operations installation runs on top of, like modules and packages.
| Command | Description |
|---|---|
| Get-UnifiedEnvironment | Get Unified Environment in Power Platform Admin Center (PPAC). |
| Get-UnifiedEnvironmentModule | Get UDE environment modules. |
| Get-UnifiedEnvironmentPackage | Get UDE environment packages. |
| New-UnifiedEnvironment | Deploy a new Unified Environment in Power Platform Admin Center (PPAC). |
| Remove-UnifiedEnvironmentModule | Remove UDE environment modules. |
| Remove-UnifiedEnvironmentPackage | Remove UDE environment packages. |
Microsoft Graph REST endpoint - AKA - Graph
This is for the things where we want to lookup details against Entra - like Security Groups and Users, to obtain their details, during the security role management capabilities that we have in the module.
| Command | Description |
|---|---|
| Get-GraphGroupMember | Get members of a Security Group from Azure AD / Entra ID. |
Inspired by different cli tools, that Microsoft has made available over the years, they use "sub" commands / groups / modules. So pac cli looks like this:
pac
Usage: pac [admin] [application] [auth] [canvas] [catalog] [code] [connection] [connector] [copilot] [data] [env] [help] [managed-identity] [model] [modelbuilder] [package] [pages] [pcf] [pipeline] [plugin] [power-fx] [solution] [telemetry] [test] [tool]
admin Work with your Power Platform Admin Account
application Commands for listing and installing available
canvas Operating with Power Apps .msapp files
catalog Commands for working with Catalog in Power
code(Preview) Commands to manage your Code apps.
connection Commands for working with Dataverse connection.
connector Commands for working with Power Platform
...
We are aiming for the same - to help people understand that we are using different tools / internal mechanisms, for when we are working with different parts of the landscape around the Dynamics 365 ERP suite, in combination with PPAC.
We know that new users of the tools might struggle with some of the concepts, but as AI assisted tools evolve, the user just needs to ask the right questions (or prompts) - then they will get help writing what ever scripts they need in their daily life.
The super user or advanced administrator, will most likely know about the concepts or quickly learn them, and then become confident on which sub cmdlets to look closer into, to solve the task at hand.