Add-AzPurviewAccountRootCollectionAdmin

Reference

Module:: Az.Purview

Add the administrator for root collection associated with this account.

Syntax

Add-AzPurviewAccountRootCollectionAdmin
   -AccountName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -ObjectId <String>
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-AzPurviewAccountRootCollectionAdmin
   -InputObject <IPurviewIdentity>
   -ObjectId <String>
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Add the administrator for root collection associated with this account.

Examples

Example 1: Add the administrator for root collection

Add-AzPurviewAccountRootCollectionAdmin -AccountName test-pa -ResourceGroupName test-rg -ObjectId xxxxxxxx-5be9-4f43-abd2-04561777c8b0

Add the administrator for root collection associated with the account named 'test-pa'.

Example 2: Add the administrator for root collection by InputObject

$got = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
Add-AzPurviewAccountRootCollectionAdmin -InputObject $got -ObjectId xxxxxxxx-5be9-4f43-abd2-04561777c8b0

Add the administrator for root collection associated with the account named 'test-pa' by InputObject.

Parameters

-AccountName

The name of the account.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-ObjectId

Gets or sets the object identifier of the admin.

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

-PassThru

Returns true when the command succeeds

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

-ResourceGroupName

The resource group name.

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

-SubscriptionId

The subscription identifier

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IPurviewIdentity

Outputs

Boolean

Share via