Tutorial Show Help

Get help content for a command

This tutorial will show you how to get the different kind of help content available for every command in the d365fo.integrations module.

Prerequisites

• Machine with D365FO installed
• PowerShell 5.1
• d365fo.integrations module installed

Please visit the Install as a Administrator or the Install as a Administrator tutorials to learn how to install the tools.

Start PowerShell

Locate the PowerShell icon, if you don't have it on your desktop or in the task pane, we can locate it in the Windows Start Menu. Search for it or type PowerShell.

Import module

You need to import / load the d365fo.integrations module into the current PowerShell console. Type the following command:

Import-Module -Name d365fo.integrations

List all available commands

For us to have something to work with, we need to get the list of available functions in the module. Type the following command:

Get-Command -Module d365fo.integrations

Get help content for a specific function

If you want to know more about a specific command, you can pass the name of the desired command to Get-Help. Type the following command:

Get-Help Get-D365ODataPublicEntity

Get help content, including examples, for a specific function

The help content for every function contains a high level explanation for each available parameter and examples. Type the following command:

Get-Help Get-D365ODataPublicEntity -Full

Get examples only, for a specific function

The help content for every function contains at least 1 example on how run the function. Type the following command:

Get-Help Get-D365ODataPublicEntity -Examples

Closing comments

In this tutorial we showed you how to list help content for a specific command, including the detailed parameter explanation and the examples.