From 90f9988cb8c2de5ede357ff4d8cf4ae38f6ec640 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 28 Oct 2024 14:42:57 -0700 Subject: [PATCH 1/6] viva insights delegates --- .../exchange-online-powershell-v2.md | 5 +- .../Add-VivaOrgInsightsDelegatedRole.md | 110 +++++++++++++++++ .../Get-VivaOrgInsightsDelegatedRole.md | 94 +++++++++++++++ .../Remove-VivaOrgInsightsDelegatedRole.md | 112 ++++++++++++++++++ exchange/exchange-ps/exchange/exchange.md | 6 + exchange/mapping/serviceMapping.json | 3 + 6 files changed, 329 insertions(+), 1 deletion(-) create mode 100644 exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md create mode 100644 exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md create mode 100644 exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 60a1167915..399ea39cf3 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -3,7 +3,7 @@ title: About the Exchange Online PowerShell V3 module ms.author: chrisda author: chrisda manager: deniseb -ms.date: 09/25/2024 +ms.date: 10/28/2024 ms.audience: Admin audience: Admin ms.topic: article @@ -193,6 +193,9 @@ Miscellaneous Exchange Online cmdlets that happen to be in the module are listed |[Get-VivaModuleFeaturePolicy](/powershell/module/exchange/get-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| |[Remove-VivaModuleFeaturePolicy](/powershell/module/exchange/remove-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| |[Update-VivaModuleFeaturePolicy](/powershell/module/exchange/update-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| ## Install and maintain the Exchange Online PowerShell module diff --git a/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md new file mode 100644 index 0000000000..d1ffc87f91 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/add-vivaorginsightsdelegatedrole +title: Add-VivaOrgInsightsDelegatedRole +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Add-VivaOrgInsightsDelegatedRole + +## SYNOPSIS +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). + +Use the Add-VivaOrgInsightsDelegatedRole cmdlet to add delegate access to the specified account (the delegatee) so they can view organizational insights like the leader (the delegator). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-VivaOrgInsightsDelegatedRole -Delegatee -Delegator + [-ResultSize ] + [] +``` + +## DESCRIPTION +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: + +- Global Administrator +- Insights Administrator + +> [!IMPORTANT] +> 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. + +## EXAMPLES + +### Example 1 +```powershell +Add-VivaOrgInsightsDelegatedRole -Delegatee 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +``` + +This example adds the organization insights viewing capability of the specified delegator account to the specified delegatee account. + +## PARAMETERS + +### -Delegatee +The Delegatee parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). + +A valid value for this parameter is the Microsoft Entra ObjectId value of the delegatee 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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegator +The Delegator parameter specifies account of the leader that can view organizational insights. The organizational insights viewing capability is delegated to the specified delegatee (the account specified by the Delegatee parameter). + +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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +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](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md new file mode 100644 index 0000000000..5c4bdd4c80 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivaorginsightsdelegatedrole +title: Get-VivaOrgInsightsDelegatedRole +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaOrgInsightsDelegatedRole + +## SYNOPSIS +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). + +Use the Get-VivaOrgInsightsDelegatedRole cmdlet to view all delegatees of the specified delegator. Delegatee accounts can view organizational insights like the specified delegator. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-VivaOrgInsightsDelegatedRole -Delegator + [-ResultSize ] + [] +``` + +## DESCRIPTION +Typically, you use this cmdlet with the Remove-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of the delegatee accounts. + +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: + +- Global Administrator +- Insights Administrator + +> [!IMPORTANT] +> 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. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaOrgInsightsDelegatedRole -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +``` + +This example filters the results by the specified delegator. + +## PARAMETERS + +### -Delegator +The Delegator parameter specifies account of the leader that can view organizational insights. The organizational insights viewing capability is delegated to delegatees. + +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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +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](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md new file mode 100644 index 0000000000..304d04c64d --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivaorginsightsdelegatedrole +title: Remove-VivaOrgInsightsDelegatedRole +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-VivaOrgInsightsDelegatedRole + +## SYNOPSIS +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). + +Use the Remove-VivaOrgInsightsDelegatedRole cmdlet to remove delegate access from the specified account (the delegatee) so they can't view organizational insights like the leader (the delegator). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-VivaOrgInsightsDelegatedRole -Delegatee -Delegator + [-ResultSize ] + [] +``` + +## DESCRIPTION +Use the Get-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of the delegatee accounts of a delegator account. + +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: + +- Global Administrator +- Insights Administrator + +> [!IMPORTANT] +> 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. + +## EXAMPLES + +### Example 1 +```powershell +Remove-VivaOrgInsightsDelegatedRole -Delegatee 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +``` + +This example removes the organization insights viewing capability of the specified delegator account from the specified delegatee account. + +## PARAMETERS + +### -Delegatee +The Delegatee parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). + +A valid value for this parameter is the Microsoft Entra ObjectId value of the delegatee 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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegator +The Delegator parameter specifies account of the leader that can view organizational insights. The organizational insights viewing capability is delegated to the specified delegatee (the account specified by the Delegatee parameter). + +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. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +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](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 453b27fad6..c466753adf 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -2333,6 +2333,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ## powershell-v3-module Cmdlets ### [Add-VivaModuleFeaturePolicy](Add-VivaModuleFeaturePolicy.md) +### [Add-VivaOrgInsightsDelegatedRole](Add-VivaOrgInsightsDelegatedRole.md) + ### [Connect-ExchangeOnline](Connect-ExchangeOnline.md) ### [Connect-IPPSSession](Connect-IPPSSession.md) @@ -2375,8 +2377,12 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-VivaModuleFeaturePolicy](Get-VivaModuleFeaturePolicy.md) +### [Get-VivaOrgInsightsDelegatedRole](Get-VivaOrgInsightsDelegatedRole.md) + ### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md) +### [Remove-VivaOrgInsightsDelegatedRole](Remove-VivaOrgInsightsDelegatedRole.md) + ### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md) ### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md) diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index be4a6a3834..9edd4710df 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -1147,6 +1147,7 @@ "Stop-ManagedFolderAssistant": "policy-and-compliance-retention", "Validate-RetentionRuleQuery": "policy-and-compliance-retention", "Add-VivaModuleFeaturePolicy": "powershell-v3-module", + "Add-VivaOrgInsightsDelegatedRole": "powershell-v3-module", "Connect-ExchangeOnline": "powershell-v3-module", "Connect-IPPSSession": "powershell-v3-module", "Disconnect-ExchangeOnline": "powershell-v3-module", @@ -1168,7 +1169,9 @@ "Get-VivaModuleFeature": "powershell-v3-module", "Get-VivaModuleFeatureEnablement": "powershell-v3-module", "Get-VivaModuleFeaturePolicy": "powershell-v3-module", + "Get-VivaOrgInsightsDelegatedRole": "powershell-v3-module", "Remove-VivaModuleFeaturePolicy": "powershell-v3-module", + "Remove-VivaOrgInsightsDelegatedRole": "powershell-v3-module", "Set-DefaultTenantBriefingConfig": "powershell-v3-module", "Set-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module", "Set-MyAnalyticsFeatureConfig": "powershell-v3-module", From 8e4cc6100ee33aada25464fa6d5673d6a4e47b15 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 28 Oct 2024 16:38:09 -0700 Subject: [PATCH 2/6] Update Connect-ExchangeOnline.md LoadCmdletHep param --- .../exchange/Connect-ExchangeOnline.md | 31 +++++++++++++++++-- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index 7360f1c356..4f644a03d4 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -44,6 +44,7 @@ Connect-ExchangeOnline [-Device] [-EnableErrorReporting] [-InlineCredential] + [LoadCmdletHelp] [-LogDirectoryPath ] [-LogLevel ] [-ManagedIdentity] @@ -496,6 +497,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LoadCmdletHelp +**Note**: This parameter is available in version 3.7.0-Preview1 or later of the module. + +The LoadCmdletHelp switch download cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch. + +Starting in v3.7.0-Preview1, help files for the command line aren't downloaded by default. Use this switch to download the files for cmdlet help at the command line. + +**Tip**: This parameter replaces the SkipLoadingCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer works, because cmdlet help files are no longer downloaded by default. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LogDirectoryPath The LogDirectoryPath parameter specifies the location of the log files. The default location is `%TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv`. @@ -678,9 +701,11 @@ Accept wildcard characters: False ### -SkipLoadingCmdletHelp **Note**: This parameter is available in version 3.3.0 or later of the module. -The SkipLoadingCmdletHelp switch avoids downloading the cmdlet help files for REST API connections. You don't need to specify a value with this switch. +In version 3.7.0-Preview1 or later, this parameter is replaced by the LoadCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer does anything, because cmdlet help files are no longer downloaded by default. Eventually, this parameter will be retired, so remove it from any scripts. + +The SkipLoadingCmdletHelp switch prevents downloading the cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch. -When you use this switch, you don't get local help files for any cmdlet. +When you use this switch, you don't get local help files for any cmdlet at the command line. This switch doesn't work with the UseRPSSession switch. @@ -698,7 +723,7 @@ Accept wildcard characters: False ``` ### -SkipLoadingFormatData -The SkipLoadingFormatData switch avoids downloading the format data for REST API connections. You don't need to specify a value with this switch. +The SkipLoadingFormatData switch prevents downloading the format data for REST API connections. You don't need to specify a value with this switch. When you use this switch, the output of any Exchange cmdlet will be unformatted. From 1202685c3ffcaea494fdcec6b5197b37977c32a8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Mon, 28 Oct 2024 16:40:19 -0700 Subject: [PATCH 3/6] Update Connect-ExchangeOnline.md --- exchange/exchange-ps/exchange/Connect-ExchangeOnline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index 4f644a03d4..1ffef012ac 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -44,7 +44,7 @@ Connect-ExchangeOnline [-Device] [-EnableErrorReporting] [-InlineCredential] - [LoadCmdletHelp] + [-LoadCmdletHelp] [-LogDirectoryPath ] [-LogLevel ] [-ManagedIdentity] From a48da1f6cc482f602ec5cbcfdc5687eeed4a672c Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 31 Oct 2024 09:41:19 -0700 Subject: [PATCH 4/6] Delegatee to Delegate --- .../Add-VivaOrgInsightsDelegatedRole.md | 16 ++++++++-------- .../Get-VivaOrgInsightsDelegatedRole.md | 6 +++--- .../Remove-VivaOrgInsightsDelegatedRole.md | 18 +++++++++--------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md index d1ffc87f91..0cd646edd6 100644 --- a/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md +++ b/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md @@ -14,14 +14,14 @@ ms.reviewer: ## SYNOPSIS 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). -Use the Add-VivaOrgInsightsDelegatedRole cmdlet to add delegate access to the specified account (the delegatee) so they can view organizational insights like the leader (the delegator). +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). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Add-VivaOrgInsightsDelegatedRole -Delegatee -Delegator +Add-VivaOrgInsightsDelegatedRole -Delegate -Delegator [-ResultSize ] [] ``` @@ -39,17 +39,17 @@ To run this cmdlet, you need to be a member of one of the following role groups ### Example 1 ```powershell -Add-VivaOrgInsightsDelegatedRole -Delegatee 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +Add-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 ``` -This example adds the organization insights viewing capability of the specified delegator account to the specified delegatee account. +This example adds the organization insights viewing capability of the specified delegator account to the specified delegate account. ## PARAMETERS -### -Delegatee -The Delegatee parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). +### -Delegate +The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). -A valid value for this parameter is the Microsoft Entra ObjectId value of the delegatee 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. +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. ```yaml Type: Guid @@ -65,7 +65,7 @@ Accept wildcard characters: False ``` ### -Delegator -The Delegator parameter specifies account of the leader that can view organizational insights. The organizational insights viewing capability is delegated to the specified delegatee (the account specified by the Delegatee parameter). +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. 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. diff --git a/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md index 5c4bdd4c80..dd36f02024 100644 --- a/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md +++ b/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS 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). -Use the Get-VivaOrgInsightsDelegatedRole cmdlet to view all delegatees of the specified delegator. Delegatee accounts can view organizational insights like the specified delegator. +Use the Get-VivaOrgInsightsDelegatedRole cmdlet to view all delegates of the specified delegator. Delegate accounts can view organizational insights like the specified delegator. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -27,7 +27,7 @@ Get-VivaOrgInsightsDelegatedRole -Delegator ``` ## DESCRIPTION -Typically, you use this cmdlet with the Remove-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of the delegatee accounts. +Typically, you use this cmdlet with the Remove-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of the delegate accounts. 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: @@ -49,7 +49,7 @@ This example filters the results by the specified delegator. ## PARAMETERS ### -Delegator -The Delegator parameter specifies account of the leader that can view organizational insights. The organizational insights viewing capability is delegated to delegatees. +The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is given to delegates. 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. diff --git a/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md index 304d04c64d..23d68dd810 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md +++ b/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md @@ -14,20 +14,20 @@ ms.reviewer: ## SYNOPSIS 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). -Use the Remove-VivaOrgInsightsDelegatedRole cmdlet to remove delegate access from the specified account (the delegatee) so they can't view organizational insights like the leader (the delegator). +Use the Remove-VivaOrgInsightsDelegatedRole cmdlet to remove delegate access from the specified account (the delegate) so they can't view organizational insights like the leader (the delegator). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Remove-VivaOrgInsightsDelegatedRole -Delegatee -Delegator +Remove-VivaOrgInsightsDelegatedRole -Delegate -Delegator [-ResultSize ] [] ``` ## DESCRIPTION -Use the Get-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of the delegatee accounts of a delegator account. +Use the Get-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of delegate accounts that were given the capabilities of delegator accounts. 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: @@ -41,17 +41,17 @@ To run this cmdlet, you need to be a member of one of the following role groups ### Example 1 ```powershell -Remove-VivaOrgInsightsDelegatedRole -Delegatee 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +Remove-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 ``` -This example removes the organization insights viewing capability of the specified delegator account from the specified delegatee account. +This example removes the organization insights viewing capability of the specified delegator account from the specified delegate account. ## PARAMETERS -### -Delegatee -The Delegatee parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). +### -Delegate +The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). -A valid value for this parameter is the Microsoft Entra ObjectId value of the delegatee 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. +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. ```yaml Type: Guid @@ -67,7 +67,7 @@ Accept wildcard characters: False ``` ### -Delegator -The Delegator parameter specifies account of the leader that can view organizational insights. The organizational insights viewing capability is delegated to the specified delegatee (the account specified by the Delegatee parameter). +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. 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. From 04b5277a819a1ab05f9c69b34463d76d9206b832 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 14 Nov 2024 08:32:21 -0800 Subject: [PATCH 5/6] Update New-TenantAllowBlockListItems.md certutil to Get-FileHash --- .../exchange-ps/exchange/New-TenantAllowBlockListItems.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index 43faa323d0..c107708874 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -79,9 +79,9 @@ This example adds a URL allow entry for the specified third-party phishing simul ### -Entries The Entries parameter specifies the values that you want to add to the Tenant Allow/Block List based on the ListType parameter value: -- FileHash: Use the SHA256 hash value of the file. In Windows, you can find the SHA256 hash value by running the following command in a Command Prompt: `certutil.exe -hashfile "\" SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. +- FileHash: Use the SHA256 hash value of the file. You can find the SHA256 hash value by running the following command in PowerShell: `Get-FileHash -Path "\" -Algorithm SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. - Sender: A domain or email address value. For example, `contoso.com` or `michelle@contoso.com`. -- URL: Use IPv4 or IPv6 addresses or hostnames. Wildcards (* and ~) are supported in hostnames. Protocols, TCP/UDP ports, or user credentials are not supported. For details, see [URL syntax for the Tenant Allow/Block List](https://learn.microsoft.com/defender-office-365/tenant-allow-block-list-urls-configure#url-syntax-for-the-tenant-allowblock-list). +- URL: Use IPv4 or IPv6 addresses or hostnames. Wildcards (\* and ~) are supported in hostnames. Protocols, TCP/UDP ports, or user credentials are not supported. For details, see [URL syntax for the Tenant Allow/Block List](https://learn.microsoft.com/defender-office-365/tenant-allow-block-list-urls-configure#url-syntax-for-the-tenant-allowblock-list). - IP: IPv6 addresses only: • Single IPv6 addresses in colon-hexadecimal format (for example, 2001:0db8:85a3:0000:0000:8a2e:0370:7334). From d7a3e550cdd609e2d3f75a2a50ce1e5d6d8b8311 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 15 Nov 2024 09:51:36 -0800 Subject: [PATCH 6/6] Update Connect-ExchangeOnline.md --- exchange/exchange-ps/exchange/Connect-ExchangeOnline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index 1ffef012ac..cc89022ef4 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -500,7 +500,7 @@ Accept wildcard characters: False ### -LoadCmdletHelp **Note**: This parameter is available in version 3.7.0-Preview1 or later of the module. -The LoadCmdletHelp switch download cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch. +The LoadCmdletHelp switch downloads cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch. Starting in v3.7.0-Preview1, help files for the command line aren't downloaded by default. Use this switch to download the files for cmdlet help at the command line.