Rnwood.Dataverse.Data.PowerShell

A PowerShell module for connecting to Microsoft Dataverse (used by Dynamics 365 and Power Apps) to query and manipulate data, solutions and customisations.

This module works in PowerShell Desktop and PowerShell Core, supporting Windows, Linux, and macOS.

Features

• Creating, updating, upserting and deleting records, including M:M records
• Simple PowerShell objects for input and output instead of complex SDK Entity classes
  • Automatic data type conversion using metadata - use friendly labels for choices and names for lookups
  • Automatic lookup conversion - use record names instead of GUIDs (when unique)
• On behalf of (delegation) support for create/update operations
• Duplicate detection support for create/update/upsert operations
• Full support for automatic paging
• Concise PowerShell-friendly hashtable-based filters with grouped logical expressions (and/or/not/xor) and arbitrary nesting
• Batching and parallelisation support for efficient bulk operations
• Auto-retries support in many cmdlets
• Comprehensive metadata operations
  • Create, read, update, and delete entities, attributes, option sets, and relationships
  • manipulate model-driven apps, forms, views
  • manipulate solutions and solution components

Note: On-premise Dataverse environments are not supported.

• An XrmToolbox plugin is also available to make getting started really easy: See the Rnwood.Dataverse.Data.PowerShell.XrmToolboxPlugin README for information.

Quick Start

Installation

# Set execution policy (one-time setup)
Set-ExecutionPolicy –ExecutionPolicy RemoteSigned –Scope CurrentUser

# Install module
Install-Module Rnwood.Dataverse.Data.PowerShell -Scope CurrentUser

For detailed installation instructions, including versioning, see Installation Guide.

Basic Usage

# Connect to Dataverse and set as default
# omit the -Url for a menu
Get-DataverseConnection -url https://myorg.crm11.dynamics.com -interactive -setasdefault

# Query records
Get-DataverseRecord -TableName contact -FilterValues @{ lastname = 'Smith' }

# Create a record
Set-DataverseRecord -TableName contact -InputObject @{ 
    firstname = 'John'
    lastname = 'Doe'
    emailaddress1 = '[email protected]'
} -CreateOnly

# Update a record
Set-DataverseRecord -TableName contact -Id $contactId -InputObject @{ 
    description = 'Updated via PowerShell'
}

# Delete a record
Remove-DataverseRecord -TableName contact -Id $contactId

For more advanced scenarios including metadata and customisations, see the documentation section below.

Documentation

Getting Started

• Installation - How to install and update the module
• Quick Start Guide - Basic operations and PowerShell best practices
• Authentication Methods - All supported authentication methods

Core Concepts

• Connection Management - Getting connected, default connections, named connections
• Querying Records - Filtering, paging, sorting, linking, SQL queries
• Creating and Updating Records - Create, update, upsert operations
• Deleting Records - Delete operations and SQL alternatives
• Record Access Management - Test, grant, list, and revoke record-level access rights
• Working with Metadata - Reading and managing schema (entities, attributes, relationships, option sets)
• Organization Settings - Getting and updating organization table columns and OrgDbOrgSettings XML
• Managing Web Resources - Upload, download, and manage web resources with file system integration
• Managing Forms - Creat, update, and managed forms
• View Management - Create, update, and manage system and personal views
• App Module Management - Create, update, and manage model-driven apps
• Environment Variables and Connection References - Managing configuration and connections
• Solution Management - Import, export, and manage solutions
• Solution Component Management - Managing individual components within solutions

Advanced Topics

• Error Handling and Batch Operations - Error handling and retry logic
• Parallelization - Parallel processing for best performance

Common Use Cases

• Use Cases - Real-world scenarios including CI/CD pipelines, data import/export, mass updates, and source control management

Reference

• Cmdlet Documentation - Full cmdlet reference with parameters and examples

Main Cmdlets

Data Operations

• Get-DataverseConnection — create or retrieve a connection
• Get-DataverseRecord — query and retrieve records
• Set-DataverseRecord — create, update or upsert records
• Remove-DataverseRecord — delete records

Advanced Operations

• Invoke-DataverseRequest — execute arbitrary SDK requests
• Invoke-DataverseSql — run SQL queries against Dataverse

Advanced Operations

• Invoke-DataverseRequest — execute arbitrary SDK requests
• Invoke-DataverseSql — run SQL queries against Dataverse

Record Access Management

• Test-DataverseRecordAccess — test access rights a principal has for a record
• Get-DataverseRecordAccess — list all principals with shared access to a record
• Set-DataverseRecordAccess — grant or modify access rights for a principal on a record
• Remove-DataverseRecordAccess — revoke access rights from a principal on a record

View Management

• Get-DataverseView — retrieve system and personal views
• Set-DataverseView — create or update views with FetchXML or simplified filters
• Remove-DataverseView — delete views

App Module Management

• Get-DataverseAppModule — retrieve app modules (model-driven apps)
• Set-DataverseAppModule — create or update app modules
• Remove-DataverseAppModule — delete app modules

App Module Component Management

• Get-DataverseAppModuleComponent — retrieve components included in an app (entities, forms, views, etc.)
• Set-DataverseAppModuleComponent — add or update a component within an app
• Remove-DataverseAppModuleComponent — remove a component from an app

Web Resource Management

• Get-DataverseWebResource — retrieve web resources with file support
• Set-DataverseWebResource — create or update web resources from files or folders
• Remove-DataverseWebResource — delete web resources

Sitemap Management

• Get-DataverseSitemap — retrieve sitemap navigation definitions
• Set-DataverseSitemap — create or update sitemap navigation
• Remove-DataverseSitemap — delete sitemap navigation
• Get-DataverseSitemapEntry — retrieve sitemap entries (Areas, Groups, SubAreas) with multilingual titles
• Set-DataverseSitemapEntry — create or update navigation entries with multilingual support
• Remove-DataverseSitemapEntry — remove navigation entries from sitemap

Environment Variables

• Get-DataverseEnvironmentVariableDefinition — query environment variable definitions
• Set-DataverseEnvironmentVariableDefinition — create or update environment variable definitions
• Remove-DataverseEnvironmentVariableDefinition — remove environment variable definitions
• Get-DataverseEnvironmentVariableValue — query environment variable values
• Set-DataverseEnvironmentVariableValue — set environment variable values
• Remove-DataverseEnvironmentVariableValue — remove environment variable values

Connection References

• Get-DataverseConnectionReference — query connection references
• Set-DataverseConnectionReference — create or update connection reference values
• Remove-DataverseConnectionReference — remove connection references

Metadata Operations

• Get-DataverseEntityMetadata — retrieve entity metadata
• Get-DataverseAttributeMetadata — retrieve attribute metadata
• Get-DataverseOptionSetMetadata — retrieve option set values
• Get-DataverseRelationshipMetadata — retrieve relationship metadata
• Get-DataverseEntityKeyMetadata — retrieve alternate key metadata
• Set-DataverseEntityMetadata — create or update entities
• Set-DataverseAttributeMetadata — create or update attributes (all types)
• Set-DataverseOptionSetMetadata — create or update global option sets
• Set-DataverseRelationshipMetadata — create relationships (OneToMany, ManyToMany)
• Set-DataverseEntityKeyMetadata — create alternate keys for entities
• Remove-DataverseEntityMetadata — delete entities
• Remove-DataverseAttributeMetadata — delete attributes
• Remove-DataverseRelationshipMetadata — delete relationships
• Remove-DataverseEntityKeyMetadata — delete alternate keys

Metadata Cache Management

• Clear-DataverseMetadataCache — clear the metadata cache

Form Management

• Get-DataverseForm — retrieve form definitions with optional FormXml parsing
• Set-DataverseForm — create or update forms with FormXml support
• Remove-DataverseForm — delete forms from entities

Form Component Management

Tabs:

• [Get-DataverseFormTab] — retrieve tabs from forms
• [Set-DataverseFormTab] — create or update form tabs
• [Remove-DataverseFormTab] — delete tabs from forms

Sections:

• [Get-DataverseFormSection] — retrieve sections from form tabs
• [Set-DataverseFormSection] — create or update form sections
• [Remove-DataverseFormSection] — delete sections from forms

Controls:

• [Get-DataverseFormControl] — retrieve controls from form sections
• [Set-DataverseFormControl] — create or update form controls (supports all standard control types and raw XML)
• [Remove-DataverseFormControl] — delete controls from forms

Additional Operations

For operations not covered by the cmdlets above, use Invoke-DataverseRequest with SDK request objects to execute any Dataverse SDK operation directly. The cmdlet supports two main approaches:

• Request parameter set: Pass SDK request objects directly (returns raw SDK response objects)
• NameAndInputs parameter set: Specify request name and parameters as hashtable (returns converted PSObject by default, use -Raw for raw response)

See the Invoke-DataverseRequest documentation for details on response conversion and parameter sets.

Support and Contributing

• Report issues: GitHub Issues
• View source: GitHub Repository

Contributing

See CONTRIBUTING.md for detailed guidelines.

License

See LICENSE file for details.