How to pipe Microsoft Dataverse Data to CSV in PowerShell

The CData Cmdlets Module for Microsoft Dataverse is a standard PowerShell module offering straightforward integration with Microsoft Dataverse. Below, you will find examples of using our CDS Cmdlets with native PowerShell cmdlets.

Getting Started

---

Creating a Connection to Your Microsoft Dataverse Data

You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
• Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

$conn = Connect-CDS -OrganizationUrl "$OrganizationUrl" -InitiateOAuth "$InitiateOAuth"

Selecting Data

Follow the steps below to retrieve data from the Accounts table and pipe the result into to a CSV file:

Select-CDS -Connection $conn -Table Accounts | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountsData.csv -NoTypeInformation

You will notice that we piped the results from Select-CDS into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-CDS -Connection $conn -Table Accounts -Where "Name = MyAccount" | Remove-CDS

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Microsoft Dataverse, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyAccountsUpdates.csv | %{
 $record = Select-CDS -Connection $CDS -Table Accounts -Where ("Id = `'"+$_.Id+"`'")
 if($record){
 Update-CDS -Connection $cds -Table Accounts -Columns ("AccountId","Name") -Values ($_.AccountId, $_.Name) -Where ("Id = `'"+$_.Id+"`'")
 }else{
 Add-CDS -Connection $cds -Table Accounts -Columns ("AccountId","Name") -Values ($_.AccountId, $_.Name)
 }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!