Get-AzPurviewDefaultAccount

Module:

Az.Purview

Get the default account for the scope.

Syntax

Get-AzPurviewDefaultAccount
   -ScopeTenantId <String>
   -ScopeType <ScopeType>
   [-Scope <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the default account for the scope.

Examples

Example 1: Get the default account for the scope Tenant.

Get-AzPurviewDefaultAccount -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a -ScopeType Tenant

AccountName ResourceGroupName Scope                                ScopeTenantId                        ScopeType SubscriptionId
----------- ----------------- -----                                -------------                        --------- --------------
test-pa      test-rg            xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a Tenant    xxxxxxxx-1bf0-4dda-aec3

Get the default account for the scope Tenant

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Scope

The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.

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

-ScopeTenantId

The tenant ID.

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

-ScopeType

The scope for the default account.

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

Outputs

IDefaultAccountPayload