PowerDMARC-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-PowerDMARC</command:name> <command:verb>Connect</command:verb> <command:noun>PowerDMARC</command:noun> <maml:description> <maml:para>Establishes a connection to the PowerDMARC API for the current session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stores the PowerDMARC API base URI, operating mode and Personal Access Token (PAT) for the current session so that other PowerDMARC module cmdlets (e.g. Get-PDDomain, Get-PDHostedSPF) can call the API without repeating authentication.</maml:para> <maml:para>PowerDMARC does not expose a username/password login endpoint. Tokens are generated manually in the PowerDMARC console under API Settings > Personal Access Tokens (or, for MSSP administrators, API Settings > Manage API Tokens) and are sent as a Bearer token on every subsequent request.</maml:para> <maml:para>PowerDMARC exposes two distinct API surfaces on the same host, rooted at different paths: - Default (End User API), rooted at /api/v1: operates on the domains that belong to the token's own account, e.g. `GET /domains/{domainId}`, `GET /hostedspf/{domainId}`. - Reseller (PowerDMARC's MSSP API), rooted at /api/v1/mssp: operates on domains belonging to the reseller's customer accounts and requires an AccountId on most calls, e.g. `GET /accounts/{accountId}/domains/{domainId}`, `GET /hosted/spf/{domainId}` (both relative to the /mssp root). -Mode determines which root the stored connection resolves to; other PowerDMARC cmdlets in this module build their relative paths off of it accordingly.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-PowerDMARC</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Token, PersonalAccessToken, PAT"> <maml:name>ApiToken</maml:name> <maml:description> <maml:para>The Personal Access Token generated in the PowerDMARC console.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The API surface to use: Default for the End User API, or Reseller for PowerDMARC's MSSP API. Determines which endpoint layout other PowerDMARC cmdlets in this module call. The earlier names Consumer and MSSP are still accepted as aliases for Default and Reseller, respectively.</maml:para> <maml:para>Defaults to Default, unless -BaseUri is also explicitly supplied, in which case it defaults to Reseller -- a caller pointing at a specific host is assumed to be an MSSP reseller pointing at their branded portal. Pass -Mode explicitly to override this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>Reseller mode only. The default MSSP customer account ID to use on calls that don't specify one explicitly (e.g. Get-PDDomain -AccountId). Ignored in Default mode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BaseUri</maml:name> <maml:description> <maml:para>The PowerDMARC host/root to call. Defaults to https://app.powerdmarc.com. MSSP resellers typically have their own branded portal host instead (e.g. reseller.powerdmarc.com) -- pass that here. Accepts a bare host, a host with scheme, or a full API root; normalized as follows: a missing scheme defaults to https://, and a missing /api/vN path defaults to /api/v1. In Reseller mode, /mssp is then appended. Do not include /mssp yourself.</maml:para> <maml:para>Examples of accepted input, all resolving the same way in Reseller mode: reseller.powerdmarc.com -> https://reseller.powerdmarc.com/api/v1/mssp https://reseller.powerdmarc.com -> https://reseller.powerdmarc.com/api/v1/mssp https://reseller.powerdmarc.com/api/v1 -> https://reseller.powerdmarc.com/api/v1/mssp</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>App.powerdmarc.com</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the connection object in addition to storing it for the session.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowBanner</maml:name> <maml:description> <maml:para>Whether to print the connection banner (mode, base URI, and a Reseller account-selection hint when applicable) after connecting. Defaults to $true; pass -ShowBanner:$false to suppress it, e.g. in unattended scripts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Token, PersonalAccessToken, PAT"> <maml:name>ApiToken</maml:name> <maml:description> <maml:para>The Personal Access Token generated in the PowerDMARC console.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The API surface to use: Default for the End User API, or Reseller for PowerDMARC's MSSP API. Determines which endpoint layout other PowerDMARC cmdlets in this module call. The earlier names Consumer and MSSP are still accepted as aliases for Default and Reseller, respectively.</maml:para> <maml:para>Defaults to Default, unless -BaseUri is also explicitly supplied, in which case it defaults to Reseller -- a caller pointing at a specific host is assumed to be an MSSP reseller pointing at their branded portal. Pass -Mode explicitly to override this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>Reseller mode only. The default MSSP customer account ID to use on calls that don't specify one explicitly (e.g. Get-PDDomain -AccountId). Ignored in Default mode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BaseUri</maml:name> <maml:description> <maml:para>The PowerDMARC host/root to call. Defaults to https://app.powerdmarc.com. MSSP resellers typically have their own branded portal host instead (e.g. reseller.powerdmarc.com) -- pass that here. Accepts a bare host, a host with scheme, or a full API root; normalized as follows: a missing scheme defaults to https://, and a missing /api/vN path defaults to /api/v1. In Reseller mode, /mssp is then appended. Do not include /mssp yourself.</maml:para> <maml:para>Examples of accepted input, all resolving the same way in Reseller mode: reseller.powerdmarc.com -> https://reseller.powerdmarc.com/api/v1/mssp https://reseller.powerdmarc.com -> https://reseller.powerdmarc.com/api/v1/mssp https://reseller.powerdmarc.com/api/v1 -> https://reseller.powerdmarc.com/api/v1/mssp</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>App.powerdmarc.com</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the connection object in addition to storing it for the session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowBanner</maml:name> <maml:description> <maml:para>Whether to print the connection banner (mode, base URI, and a Reseller account-selection hint when applicable) after connecting. Defaults to $true; pass -ShowBanner:$false to suppress it, e.g. in unattended scripts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$token = Read-Host -AsSecureString -Prompt 'PowerDMARC API token' Connect-PowerDMARC -ApiToken $token</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Connect-PowerDMARC -ApiToken (ConvertTo-SecureString $env:POWERDMARC_TOKEN -AsPlainText -Force) -Mode Reseller -AccountId 42</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/getting-started</maml:linkText> <maml:uri>https://api.powerdmarc.com/getting-started</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/authentication</maml:linkText> <maml:uri>https://api.powerdmarc.com/authentication</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-PDHostedSPF</command:name> <command:verb>Export</command:verb> <command:noun>PDHostedSPF</command:noun> <maml:description> <maml:para>Exports Hosted SPF (PowerSPF) configuration to one JSON file per domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Calls Get-PDHostedSPF for each domain ID and writes every returned record to its own JSON file under -Path, named after the domain. Modeled after the per-object JSON export pattern used by Microsoft's EntraExporter (https://github.com/microsoft/EntraExporter): one file per object rather than one combined dump, with a guard against exceeding the Windows 260-character MAX_PATH.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PDHostedSPF</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>The PowerDMARC domain ID(s) to export. Accepts pipeline input, including by property name (e.g. piped from Get-PDDomain). If omitted (and nothing is piped in), every domain visible to Get-PDDomain is enumerated and exported -- in Reseller mode that means the selected account only, unless -All is also used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Reseller mode only. Passed through to Get-PDDomain: exports domains across every customer account instead of just the selected one. Ignored if -DomainId is also given.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Directory to write the exported JSON files to. Created if it doesn't already exist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledOnly</maml:name> <maml:description> <maml:para>Only export entries where is_enabled is true. Passed through to Get-PDHostedSPF.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>JSON serialization depth passed to ConvertTo-Json. Defaults to 10.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>The PowerDMARC domain ID(s) to export. Accepts pipeline input, including by property name (e.g. piped from Get-PDDomain). If omitted (and nothing is piped in), every domain visible to Get-PDDomain is enumerated and exported -- in Reseller mode that means the selected account only, unless -All is also used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Reseller mode only. Passed through to Get-PDDomain: exports domains across every customer account instead of just the selected one. Ignored if -DomainId is also given.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Directory to write the exported JSON files to. Created if it doesn't already exist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledOnly</maml:name> <maml:description> <maml:para>Only export entries where is_enabled is true. Passed through to Get-PDHostedSPF.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>JSON serialization depth passed to ConvertTo-Json. Defaults to 10.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Export-PDHostedSPF -DomainId 12345 -Path C:\Export</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Export-PDHostedSPF -Path C:\Export -EnabledOnly # Exports every domain under the selected account (Reseller mode requires an AccountId # via Select-PDAccount or Connect-PowerDMARC -AccountId).</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Export-PDHostedSPF -All -Path C:\Export -EnabledOnly # Exports every domain across every customer account (Reseller mode).</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-PDDomain | Export-PDHostedSPF -Path C:\Export -EnabledOnly</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/microsoft/EntraExporter</maml:linkText> <maml:uri>https://github.com/microsoft/EntraExporter</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PDAccount</command:name> <command:verb>Get</command:verb> <command:noun>PDAccount</command:noun> <maml:description> <maml:para>Retrieves PowerDMARC MSSP customer account(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Calls the PowerDMARC MSSP Account Management API (relative to the /mssp root stored by Connect-PowerDMARC -Mode Reseller): - `GET /accounts/{accountId}` for a specific account. - `GET /accounts?dateFrom=...&dateTo=...` to list customer accounts created within a date range. The API requires both dateFrom and dateTo on the list call; if omitted here, they default to the last 30 days.</maml:para> <maml:para>Requires an active connection created with Connect-PowerDMARC -Mode Reseller. Accounts are a Reseller-only concept; this cmdlet is not available in Default mode.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PDAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>The MSSP account ID(s) to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PDAccount</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DateFrom</maml:name> <maml:description> <maml:para>Start of the date range to list accounts for. Defaults to 30 days ago.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>(Get-Date).AddDays(-30)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DateTo</maml:name> <maml:description> <maml:para>End of the date range to list accounts for. Defaults to today.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>(Get-Date)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>The MSSP account ID(s) to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DateFrom</maml:name> <maml:description> <maml:para>Start of the date range to list accounts for. Defaults to 30 days ago.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>(Get-Date).AddDays(-30)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DateTo</maml:name> <maml:description> <maml:para>End of the date range to list accounts for. Defaults to today.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>(Get-Date)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-PDAccount # Lists accounts from the last 30 days.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-PDAccount -DateFrom '2026-01-01' -DateTo '2026-12-31'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-PDAccount -AccountId 42</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-PDAccount -DateFrom (Get-Date).AddMonths(-1) -DateTo (Get-Date) | Select-PDAccount</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:linkText> <maml:uri>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PDDomain</command:name> <command:verb>Get</command:verb> <command:noun>PDDomain</command:noun> <maml:description> <maml:para>Retrieves PowerDMARC domain(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Calls the PowerDMARC Domain Management API. Requires an active connection created with Connect-PowerDMARC.</maml:para> <maml:para>Behavior depends on the mode (and root URI) stored by Connect-PowerDMARC: - Default mode (root /api/v1): `GET /domains/{domainId}` for a specific domain, or `GET /domains` to list every domain on the token's own account. - Reseller mode (root /api/v1/mssp): `GET /accounts/{accountId}/domains/{domainId}` for a specific domain, or `GET /accounts/{accountId}/domains` to list every domain under the given MSSP customer account. AccountId is required in this mode.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PDDomain</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>The PowerDMARC domain ID(s) to retrieve. Omit to list every domain in scope.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Id"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>Reseller mode only. The MSSP customer account ID that owns the domain(s). Defaults to the account selected via Select-PDAccount (or set with Connect-PowerDMARC -AccountId), if any. Accepts pipeline input by property name, including directly from Get-PDAccount (its "id" property). Ignored when -All is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Reseller mode only. Ignores AccountId/the selected account and instead lists every customer account ever created (via Get-PDAccount, spanning its full history rather than its default 30-day window) and every domain under each of them. PowerDMARC's MSSP API has no single account-less "list all domains" endpoint, so this makes one /accounts/{accountId}/domains call per account to cover the whole reseller.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>The PowerDMARC domain ID(s) to retrieve. Omit to list every domain in scope.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Id"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>Reseller mode only. The MSSP customer account ID that owns the domain(s). Defaults to the account selected via Select-PDAccount (or set with Connect-PowerDMARC -AccountId), if any. Accepts pipeline input by property name, including directly from Get-PDAccount (its "id" property). Ignored when -All is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Reseller mode only. Ignores AccountId/the selected account and instead lists every customer account ever created (via Get-PDAccount, spanning its full history rather than its default 30-day window) and every domain under each of them. PowerDMARC's MSSP API has no single account-less "list all domains" endpoint, so this makes one /accounts/{accountId}/domains call per account to cover the whole reseller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-PDDomain -DomainId 12345</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-PDDomain</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-PDDomain -AccountId 42 -DomainId 12345</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-PDAccount | Get-PDDomain # Lists domains for every account returned, using each account's id as -AccountId.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-PDDomain -All # Same result as the example above, without fetching accounts yourself first.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/api/end-user/api-v-1-documentation</maml:linkText> <maml:uri>https://api.powerdmarc.com/api/end-user/api-v-1-documentation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:linkText> <maml:uri>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PDHostedSPF</command:name> <command:verb>Get</command:verb> <command:noun>PDHostedSPF</command:noun> <maml:description> <maml:para>Retrieves the Hosted SPF (PowerSPF) configuration for one or more PowerDMARC domains.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Calls the PowerDMARC Hosted SPF API for each domain ID and returns the SPF mechanisms PowerDMARC is currently hosting/flattening on that domain's behalf. Requires an active connection created with Connect-PowerDMARC.</maml:para> <maml:para>Behavior depends on the mode (and root URI) stored by Connect-PowerDMARC: - Default mode (root /api/v1): `GET /hostedspf/{domainId}` - Reseller mode (root /api/v1/mssp): `GET /hosted/spf/{domainId}`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PDHostedSPF</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>The PowerDMARC domain ID(s) to retrieve the Hosted SPF configuration for. Accepts pipeline input, including by property name (e.g. piped from Get-PDDomain). Defaults to the domain selected via Select-PDDomain, if any.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledOnly</maml:name> <maml:description> <maml:para>Only return entries where is_enabled is true.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>The PowerDMARC domain ID(s) to retrieve the Hosted SPF configuration for. Accepts pipeline input, including by property name (e.g. piped from Get-PDDomain). Defaults to the domain selected via Select-PDDomain, if any.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledOnly</maml:name> <maml:description> <maml:para>Only return entries where is_enabled is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-PDHostedSPF -DomainId 12345</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>12345, 67890 | Get-PDHostedSPF</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-PDDomain | Get-PDHostedSPF</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Select-PDDomain -DomainId 12345 Get-PDHostedSPF</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/api/end-user/api-v-1-documentation</maml:linkText> <maml:uri>https://api.powerdmarc.com/api/end-user/api-v-1-documentation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:linkText> <maml:uri>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Select-PDAccount</command:name> <command:verb>Select</command:verb> <command:noun>PDAccount</command:noun> <maml:description> <maml:para>Sets the default MSSP customer account for the current PowerDMARC session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the AccountId stored by Connect-PowerDMARC so that subsequent calls to Reseller-mode cmdlets (e.g. Get-PDDomain, Get-PDHostedSPF) that need an AccountId don't have to pass -AccountId every time. Only meaningful in Reseller mode.</maml:para> <maml:para>By default the account is verified with a Get-PDAccount call before being selected, so a mistyped or inaccessible AccountId fails immediately rather than on the next unrelated call. Use -SkipValidation to select without that check.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Select-PDAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id, account_id"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>The MSSP account ID to make the default for this session. Accepts pipeline input, including directly from Get-PDAccount.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipValidation</maml:name> <maml:description> <maml:para>Set the AccountId without first verifying it via the API.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the selected account object (or, with -SkipValidation, the AccountId) instead of producing no output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id, account_id"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>The MSSP account ID to make the default for this session. Accepts pipeline input, including directly from Get-PDAccount.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipValidation</maml:name> <maml:description> <maml:para>Set the AccountId without first verifying it via the API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the selected account object (or, with -SkipValidation, the AccountId) instead of producing no output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Select-PDAccount -AccountId 42</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-PDAccount | Where-Object name -eq 'Contoso' | Select-PDAccount</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:linkText> <maml:uri>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Select-PDDomain</command:name> <command:verb>Select</command:verb> <command:noun>PDDomain</command:noun> <maml:description> <maml:para>Sets the default domain for the current PowerDMARC session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the DomainId stored by Connect-PowerDMARC so that subsequent calls to cmdlets that need a DomainId (currently Get-PDHostedSPF) don't have to pass -DomainId every time. Works in both Default and Reseller mode.</maml:para> <maml:para>By default the domain is verified with a Get-PDDomain call before being selected (in Reseller mode this uses the already-selected AccountId, so select an account first there), so a mistyped or inaccessible DomainId fails immediately rather than on the next unrelated call. Use -SkipValidation to select without that check.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Select-PDDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>The domain ID to make the default for this session. Accepts pipeline input, including directly from Get-PDDomain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipValidation</maml:name> <maml:description> <maml:para>Set the DomainId without first verifying it via the API.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the selected domain object (or, with -SkipValidation, the DomainId) instead of producing no output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>The domain ID to make the default for this session. Accepts pipeline input, including directly from Get-PDDomain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipValidation</maml:name> <maml:description> <maml:para>Set the DomainId without first verifying it via the API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the selected domain object (or, with -SkipValidation, the DomainId) instead of producing no output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Select-PDDomain -DomainId 158463</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-PDDomain | Where-Object domain -eq 'meiertobler.ch' | Select-PDDomain</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/api/end-user/api-v-1-documentation</maml:linkText> <maml:uri>https://api.powerdmarc.com/api/end-user/api-v-1-documentation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:linkText> <maml:uri>https://api.powerdmarc.com/api/mssp/api-v-1-documentation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |