Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
61 changes: 61 additions & 0 deletions docs/reference/extension/commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!-- Auto-generated by scripts/docs-gen/ext-reflect — edits will be overwritten on next release. -->

# Commands

| Command ID | Title | Category | Default Keybinding | When Clause |
|---|---|---|---|---|
| `ppds.configureEnvironment` | Configure Environment | PPDS | | |
| `ppds.copyEnvironmentUrl` | Copy URL | | | |
| `ppds.createProfile` | Create Profile | PPDS | | |
| `ppds.dataExplorer` | Open Data Explorer | PPDS | | |
| `ppds.debug.daemonStatus` | Daemon Status | PPDS Debug | | |
| `ppds.debug.extensionState` | Extension State | PPDS Debug | | |
| `ppds.debug.panelState` | Panel State | PPDS Debug | | |
| `ppds.debug.treeViewState` | Tree View State | PPDS Debug | | |
| `ppds.deleteProfile` | Delete Profile | PPDS | | |
| `ppds.environmentDetails` | Environment Details | PPDS | | |
| `ppds.exportCellResultsCsv` | Export Cell Results to CSV | PPDS | | |
| `ppds.exportCellResultsJson` | Export Cell Results to JSON | PPDS | | |
| `ppds.invalidateProfile` | Invalidate Tokens | PPDS | | |
| `ppds.listProfiles` | List Profiles | PPDS | | |
| `ppds.moveProfileDown` | Move Down | | | |
| `ppds.moveProfileUp` | Move Up | | | |
| `ppds.newNotebook` | New Notebook | PPDS | | |
| `ppds.openCellInDataExplorer` | Open in Data Explorer | PPDS | | |
| `ppds.openConnectionReferences` | Open Connection References | PPDS | | |
| `ppds.openConnectionReferencesForEnv` | Open Connection References | | | |
| `ppds.openDataExplorerForEnv` | Open Data Explorer | | | |
| `ppds.openDocumentation` | Open Documentation | PPDS | | |
| `ppds.openEnvironmentVariables` | Open Environment Variables | PPDS | | |
| `ppds.openEnvironmentVariablesForEnv` | Open Environment Variables | | | |
| `ppds.openImportJobs` | Open Import Jobs | PPDS | | |
| `ppds.openImportJobsForEnv` | Open Import Jobs | | | |
| `ppds.openInDynamics` | Open in Dynamics 365 | | | |
| `ppds.openInMaker` | Open in Maker Portal | | | |
| `ppds.openMetadataBrowser` | Open Metadata Browser | PPDS | | |
| `ppds.openMetadataBrowserForEnv` | Open Metadata Browser | PPDS | | |
| `ppds.openNotebooks` | Open Notebooks | PPDS | | |
| `ppds.openPlugins` | Open Plugin Registration | PPDS | | |
| `ppds.openPluginsForEnv` | Open Plugin Registration | | | |
| `ppds.openPluginTraces` | Open Plugin Traces | PPDS | | |
| `ppds.openPluginTracesForEnv` | Open Plugin Traces | | | |
| `ppds.openQueryInNotebook` | Open Query in Notebook | PPDS | | |
| `ppds.openSolutions` | Open Solutions | PPDS | | |
| `ppds.openSolutionsForEnv` | Open Solutions | | | |
| `ppds.openWebResources` | Open Web Resources | PPDS | | |
| `ppds.openWebResourcesForEnv` | Open Web Resources | | | |
| `ppds.pluginTreeDisableStep` | Disable Step | PPDS | | |
| `ppds.pluginTreeDownload` | Download Binary | PPDS | | |
| `ppds.pluginTreeEnableStep` | Enable Step | PPDS | | |
| `ppds.pluginTreeUnregister` | Unregister | PPDS | | |
| `ppds.profileDetails` | Profile Details | PPDS | | |
| `ppds.refreshProfiles` | Refresh | | | |
| `ppds.removeEnvironment` | Remove Environment | | | |
| `ppds.renameProfile` | Rename Profile | PPDS | | |
| `ppds.restartDaemon` | Restart Daemon | PPDS | | |
| `ppds.selectNotebookEnvironment` | Select Notebook Environment | PPDS | | |
| `ppds.selectProfile` | Select Profile | PPDS | | |
| `ppds.setDefaultEnvironment` | Set as Default | | | |
| `ppds.showLogs` | Show Logs | PPDS | | |
| `ppds.testConnection` | Test Connection | | | |
| `ppds.toggleNotebookCellLanguage` | Toggle SQL/FetchXML | PPDS | | |
8 changes: 8 additions & 0 deletions docs/reference/extension/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!-- Auto-generated by scripts/docs-gen/ext-reflect — edits will be overwritten on next release. -->

# Configuration

| Setting | Type | Default | Description |
|---|---|---|---|
| `ppds.autoStartDaemon` | `boolean` | `true` | Automatically start the ppds serve daemon when the extension activates |
| `ppds.queryDefaultTop` | `number` | `100` | Default TOP value for SQL queries when none specified |
10 changes: 10 additions & 0 deletions docs/reference/extension/views.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!-- Auto-generated by scripts/docs-gen/ext-reflect — edits will be overwritten on next release. -->

# Views

## `ppds` (activitybar)

Title: Power Platform Developer Suite

- `ppds.profiles` — Profiles
- `ppds.tools` — Tools
32 changes: 32 additions & 0 deletions docs/reference/libraries/Auth/AuthDebugLog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!-- Auto-generated by scripts/docs-gen/libs-reflect — edits will be overwritten on next release. -->

# AuthDebugLog

- Namespace: `PPDS.Auth`
- Assembly: `PPDS.Auth`
- Kind: Class

## Summary

Controls debug logging output for the auth library.

## Members

### Methods

#### Reset

`void Reset()`

Resets the writer to null (no output).


### Properties

#### Writer

`Action<string> Writer { get; set; }`

Gets or sets the action used to write debug messages.
Set to null to suppress all output (default).

33 changes: 33 additions & 0 deletions docs/reference/libraries/Auth/AuthenticationOutput.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!-- Auto-generated by scripts/docs-gen/libs-reflect — edits will be overwritten on next release. -->

# AuthenticationOutput

- Namespace: `PPDS.Auth`
- Assembly: `PPDS.Auth`
- Kind: Class

## Summary

Controls authentication status output for the auth library.

## Members

### Methods

#### Reset

`void Reset()`

Resets the writer to the default (Console.Error / stderr).


### Properties

#### Writer

`Action<string> Writer { get; set; }`

Gets or sets the action used to write authentication status messages.
Set to null to suppress all output, or provide a custom action to redirect.
Default: writes to Console.Error (stderr — stdout is reserved for data per PPDS I1/NEVER rule)

130 changes: 130 additions & 0 deletions docs/reference/libraries/Auth/Cloud/CloudEndpoints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
<!-- Auto-generated by scripts/docs-gen/libs-reflect — edits will be overwritten on next release. -->

# CloudEndpoints

- Namespace: `PPDS.Auth.Cloud`
- Assembly: `PPDS.Auth`
- Kind: Class

## Summary

Provides endpoint URLs for different Azure cloud environments.

## Members

### Methods

#### GetAuthorityBaseUrl

`string GetAuthorityBaseUrl(CloudEnvironment cloud)`

Gets the base authority URL (without tenant) for the specified cloud environment.

- Param `cloud`: The cloud environment.

- Returns: The base authority URL.

#### GetAuthorityHost

`Uri GetAuthorityHost(CloudEnvironment cloud)`

Gets the Azure.Identity authority host URI for the specified cloud environment.

- Param `cloud`: The cloud environment.

- Returns: The authority host URI.

#### GetAuthorityUrl

`string GetAuthorityUrl(CloudEnvironment cloud, string tenantId)`

Gets the Azure AD authority URL for the specified cloud environment.

- Param `cloud`: The cloud environment.

- Param `tenantId`: Optional tenant ID. Defaults to "organizations" for multi-tenant.

- Returns: The authority URL.

#### GetAzureCloudInstance

`AzureCloudInstance GetAzureCloudInstance(CloudEnvironment cloud)`

Gets the MSAL Azure cloud instance for the specified cloud environment.

- Param `cloud`: The cloud environment.

- Returns: The Azure cloud instance.

#### GetFlowPortalUrl

`string GetFlowPortalUrl(CloudEnvironment cloud)`

Gets the Power Automate Maker portal base URL for the specified cloud environment.

- Param `cloud`: The cloud environment.

- Returns: The Flow portal base URL (no trailing slash).

#### GetGlobalDiscoveryUrl

`string GetGlobalDiscoveryUrl(CloudEnvironment cloud)`

Gets the Global Discovery Service URL for the specified cloud environment.

- Param `cloud`: The cloud environment.

- Returns: The Global Discovery Service URL.

#### GetMakerPortalUrl

`string GetMakerPortalUrl(CloudEnvironment cloud)`

Gets the Power Apps Maker portal base URL for the specified cloud environment.

- Param `cloud`: The cloud environment.

- Returns: The Maker portal base URL (no trailing slash).

#### GetPowerAppsApiUrl

`string GetPowerAppsApiUrl(CloudEnvironment cloud)`

Gets the Power Apps API base URL for the specified cloud environment.
Used for connections, flows, and other Power Platform management APIs.

- Param `cloud`: The cloud environment.

- Returns: The Power Apps API base URL.

#### GetPowerAppsServiceScope

`string GetPowerAppsServiceScope(CloudEnvironment cloud)`

Gets the Power Apps Service scope URL for the specified cloud environment.
This is the resource/audience used when acquiring tokens for the Flow API and Connections API.

- Param `cloud`: The cloud environment.

- Returns: The Power Apps Service scope URL (without /.default suffix).

#### GetPowerAutomateApiUrl

`string GetPowerAutomateApiUrl(CloudEnvironment cloud)`

Gets the Power Automate (Flow) API base URL for the specified cloud environment.

- Param `cloud`: The cloud environment.

- Returns: The Power Automate API base URL.

#### Parse

`CloudEnvironment Parse(string value)`

Parses a cloud environment from a string value.

- Param `value`: The string value (case-insensitive).

- Returns: The cloud environment.

52 changes: 52 additions & 0 deletions docs/reference/libraries/Auth/Cloud/CloudEnvironment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<!-- Auto-generated by scripts/docs-gen/libs-reflect — edits will be overwritten on next release. -->

# CloudEnvironment

- Namespace: `PPDS.Auth.Cloud`
- Assembly: `PPDS.Auth`
- Kind: Enum
- Implements: `IComparable`, `IConvertible`, `IFormattable`, `ISpanFormattable`

## Summary

Azure cloud environments for Dataverse authentication.

## Members

### Fields

#### China

`CloudEnvironment China`

Azure China Cloud (21Vianet).
Authority: https://login.chinacloudapi.cn

#### Public

`CloudEnvironment Public`

Azure Public Cloud (default).
Authority: https://login.microsoftonline.com

#### UsGov

`CloudEnvironment UsGov`

Azure US Government Cloud.
Authority: https://login.microsoftonline.us

#### UsGovDod

`CloudEnvironment UsGovDod`

Azure US Government DoD Cloud.
Authority: https://login.microsoftonline.us

#### UsGovHigh

`CloudEnvironment UsGovHigh`

Azure US Government High Cloud.
Authority: https://login.microsoftonline.us

Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<!-- Auto-generated by scripts/docs-gen/libs-reflect — edits will be overwritten on next release. -->

# AuthenticationException

- Namespace: `PPDS.Auth.Credentials`
- Assembly: `PPDS.Auth`
- Kind: Class
- Base: `Exception`
- Implements: `ISerializable`

## Summary

Exception thrown when authentication fails.

## Members

### Constructors

#### AuthenticationException(string message)

`AuthenticationException(string message)`

Creates a new authentication exception.

- Param `message`: The error message.

#### AuthenticationException(string message, Exception innerException)

`AuthenticationException(string message, Exception innerException)`

Creates a new authentication exception with an inner exception.

- Param `message`: The error message.

- Param `innerException`: The inner exception.

#### AuthenticationException(string message, string errorCode, Exception innerException)

`AuthenticationException(string message, string errorCode, Exception innerException)`

Creates a new authentication exception with an error code.

- Param `message`: The error message.

- Param `errorCode`: The error code.

- Param `innerException`: The inner exception.


### Properties

#### ErrorCode

`string ErrorCode { get; }`

Gets the error code, if available.

Loading
Loading