Skip to main content

Get-PDDomain

SYNOPSIS​

Retrieves PowerDMARC domain(s).

SYNTAX​

Get-PDDomain [[-DomainId] <Int32[]>] [-AccountId <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Calls the PowerDMARC Domain Management API. Requires an active connection created with Connect-PowerDMARC.

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.

EXAMPLES​

EXAMPLE 1​

Get-PDDomain -DomainId 12345

EXAMPLE 2​

Get-PDDomain

EXAMPLE 3​

Get-PDDomain -AccountId 42 -DomainId 12345

EXAMPLE 4​

Get-PDAccount | Get-PDDomain
# Lists domains for every account returned, using each account's id as -AccountId.

PARAMETERS​

-DomainId​

The PowerDMARC domain ID(s) to retrieve. Omit to list every domain in scope.

Type: Int32[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-AccountId​

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).

Type: Int32
Parameter Sets: (All)
Aliases: Id

Required: False
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ProgressAction​

Fill ProgressAction Description

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

System.Management.Automation.PSObject​

NOTES​

https://api.powerdmarc.com/api/end-user/api-v-1-documentation

https://api.powerdmarc.com/api/mssp/api-v-1-documentation