|
| 1 | +--- |
| 2 | +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml |
| 3 | +Module Name: ExchangeOnlineManagement |
| 4 | +online version: https://learn.microsoft.com/powershell/module/exchange/add-vivaorginsightsdelegatedrole |
| 5 | +title: Add-VivaOrgInsightsDelegatedRole |
| 6 | +schema: 2.0.0 |
| 7 | +author: chrisda |
| 8 | +ms.author: chrisda |
| 9 | +ms.reviewer: |
| 10 | +--- |
| 11 | + |
| 12 | +# Add-VivaOrgInsightsDelegatedRole |
| 13 | + |
| 14 | +## SYNOPSIS |
| 15 | +This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). |
| 16 | + |
| 17 | +Use the Add-VivaOrgInsightsDelegatedRole cmdlet to add delegate access to the specified account (the delegate) so they can view organizational insights like the leader (the delegator). |
| 18 | + |
| 19 | +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). |
| 20 | + |
| 21 | +## SYNTAX |
| 22 | + |
| 23 | +``` |
| 24 | +Add-VivaOrgInsightsDelegatedRole -Delegate <Guid> -Delegator <Guid> |
| 25 | + [-ResultSize <Unlimited>] |
| 26 | + [<CommonParameters>] |
| 27 | +``` |
| 28 | + |
| 29 | +## DESCRIPTION |
| 30 | +To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization: |
| 31 | + |
| 32 | +- Global Administrator |
| 33 | +- Insights Administrator |
| 34 | + |
| 35 | +> [!IMPORTANT] |
| 36 | +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. |
| 37 | +
|
| 38 | +## EXAMPLES |
| 39 | + |
| 40 | +### Example 1 |
| 41 | +```powershell |
| 42 | +Add-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 |
| 43 | +``` |
| 44 | + |
| 45 | +This example adds the organization insights viewing capability of the specified delegator account to the specified delegate account. |
| 46 | + |
| 47 | +## PARAMETERS |
| 48 | + |
| 49 | +### -Delegate |
| 50 | +The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). |
| 51 | + |
| 52 | +A valid value for this parameter is the Microsoft Entra ObjectId value of the delegate account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. |
| 53 | + |
| 54 | +```yaml |
| 55 | +Type: Guid |
| 56 | +Parameter Sets: (All) |
| 57 | +Aliases: |
| 58 | +Applicable: Exchange Online |
| 59 | + |
| 60 | +Required: True |
| 61 | +Position: Named |
| 62 | +Default value: None |
| 63 | +Accept pipeline input: False |
| 64 | +Accept wildcard characters: False |
| 65 | +``` |
| 66 | +
|
| 67 | +### -Delegator |
| 68 | +The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is delegated to the account specified by the Delegate parameter. |
| 69 | +
|
| 70 | +A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. |
| 71 | +
|
| 72 | +```yaml |
| 73 | +Type: Guid |
| 74 | +Parameter Sets: (All) |
| 75 | +Aliases: |
| 76 | +Applicable: Exchange Online |
| 77 | + |
| 78 | +Required: True |
| 79 | +Position: Named |
| 80 | +Default value: None |
| 81 | +Accept pipeline input: False |
| 82 | +Accept wildcard characters: False |
| 83 | +``` |
| 84 | +
|
| 85 | +### -ResultSize |
| 86 | +This parameter is reserved for internal Microsoft use. |
| 87 | +
|
| 88 | +```yaml |
| 89 | +Type: Unlimited |
| 90 | +Parameter Sets: (All) |
| 91 | +Aliases: |
| 92 | +Applicable: Exchange Online |
| 93 | + |
| 94 | +Required: False |
| 95 | +Position: Named |
| 96 | +Default value: None |
| 97 | +Accept pipeline input: False |
| 98 | +Accept wildcard characters: False |
| 99 | +``` |
| 100 | +
|
| 101 | +### CommonParameters |
| 102 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). |
| 103 | +
|
| 104 | +## INPUTS |
| 105 | +
|
| 106 | +## OUTPUTS |
| 107 | +
|
| 108 | +## NOTES |
| 109 | +
|
| 110 | +## RELATED LINKS |
0 commit comments