Skip to content

[AutoPublish] main to live - 08/11 19:56 PDT | 08/12 08:26 IST #13040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ title: Add-VivaModuleFeaturePolicy
# Add-VivaModuleFeaturePolicy

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).

Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. The attributes of the policy are defined using the cmdlet parameters. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant.

Expand Down Expand Up @@ -244,7 +244,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

This parameter is available in version 3.3.0 or later of the module.
**Note**: This parameter is available in module version 3.3.0 or later.

The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are:

Expand All @@ -269,7 +269,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

This parameter is available in version 3.8.0-Preview2 or later of the module.
**Note**: This parameter is available in module version 3.8.0-Preview2 or later.

The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Add-VivaOrgInsightsDelegatedRole
# Add-VivaOrgInsightsDelegatedRole

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.7.1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
This cmdlet is available only in the Exchange Online PowerShell module version 3.7.1 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 delegate) so they can view organizational insights like the leader (the delegator).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.1.0 or later of the module.
**Note**: This parameter is available in module version 3.1.0 or later.

The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to Exchange Online.

Expand Down Expand Up @@ -474,7 +474,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 2.0.4 or later of the module, and only in PowerShell 7.
**Note**: This parameter is available in module version 2.0.4 or later, and only in PowerShell 7.

The Device switch is typically used on computers without web browsers. You don't need to specify a value with this switch.

Expand All @@ -498,7 +498,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.7.2-Preview1 or later of the module.
**Note**: This parameter is available in module version 3.7.2-Preview1 or later.

The DisableWAM switch disables Web Account Manager (WAM). You don't need to specify a value with this switch.

Expand Down Expand Up @@ -538,7 +538,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 2.0.4 or later of the module, and only in PowerShell 7.
**Note**: This parameter is available in module version 2.0.4 or later, and only in PowerShell 7.

The InlineCredential switch specifies whether to pass credentials directly in the Windows PowerShell window. You don't need to specify a value with this switch.

Expand All @@ -562,7 +562,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.7.0-Preview1 or later of the module.
**Note**: This parameter is available in module version 3.7.0-Preview1 or later.

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.

Expand Down Expand Up @@ -759,7 +759,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.2.0 or later of the module.
**Note**: This parameter is available in module version 3.2.0 or later.

The SigningCertificate parameter specifies the client certificate that's used to sign the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that Connect-ExchangeOnline creates.

Expand All @@ -783,7 +783,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.3.0 or later of the module.
**Note**: This parameter is available in module version 3.3.0 or later.

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.

Expand Down Expand Up @@ -901,8 +901,6 @@ Accept wildcard characters: False

The UseRPSSession switch allows you to connect to Exchange Online PowerShell using traditional remote PowerShell access to all cmdlets. You don't need to specify a value with this switch.

This switch requires that Basic authentication is enabled in WinRM on the local computer. For more information, see [Turn on Basic authentication in WinRM](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm).

If you don't use this switch, REST API mode is used for the connection, so Basic authentication in WinRM isn't required.

```yaml
Expand Down
145 changes: 138 additions & 7 deletions exchange/exchange-ps/ExchangePowerShell/Connect-IPPSSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,13 @@ Connect-IPPSSession
[-CertificatePassword <SecureString>]
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-DisableWAM]
[-EnableErrorReporting]
[-EnableSearchOnlySession]
[-LogDirectoryPath <String>]
[-LogLevel <LogLevel>]
[-Organization <String>]
[-ShowBanner]
[-UserPrincipalName <String>]
[-UseRPSSession]
[<CommonParameters>]
Expand Down Expand Up @@ -237,7 +243,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.8.0-Preview1 or later of the module.
**Note**: This parameter is available in module version 3.8.0-Preview1 or later.

The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to Security and Compliance PowerShell.

Expand Down Expand Up @@ -411,6 +417,110 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -DisableWAM

> Applicable: Exchange Online

**Note**: This parameter is available in module version 3.7.2 or later.

The DisableWAM switch disables Web Account Manager (WAM). You don't need to specify a value with this switch.

If you encounter WAM-related issues during sign in, you can use this switch to disable WAM.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

### -EnableErrorReporting

> Applicable: Exchange Online

**Note**: This parameter is available in module version 3.9.0-Preview1 or later.

The EnableErrorReporting switch specifies whether to enable error reporting. You don't need to specify a value with this switch.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

### -EnableSearchOnlySession

> Applicable: Exchange Online

**Note**: This parameter is available in module version 3.9.0-Preview1 or later.

The EnableSearchOnlySession switch specifies whether to enable certain eDiscovery and related cmdlets that connect to other Microsoft 365 services. You don't need to specify a value with this switch.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

### -LogDirectoryPath

> Applicable: Exchange Online

**Note**: This parameter is available in module version 3.9.0-Preview1 or later.

The LogDirectoryPath parameter specifies the location of the log files. The default location is `%TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv`.

If you specify a custom location and filename that contains spaces, enclose the value in quotation marks (").

```yaml
Type: String
Parameter Sets: (All)
Aliases:

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

### -LogLevel

> Applicable: Exchange Online

**Note**: This parameter is available in module version 3.9.0-Preview1 or later.

The LogLevel parameter specifies the logging level. Valid values are Default and All.

```yaml
Type: LogLevel
Parameter Sets: (All)
Aliases:

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

### -Organization

> Applicable: Exchange Online
Expand All @@ -431,11 +541,34 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ShowBanner

> Applicable: Exchange Online

**Note**: This parameter is available in module version 3.2.0 or later.

The ShowBanner switch shows or hides the banner message that's displayed when you run Connect-IPPSSession. You don't need to specify a value with this switch.

- To show the banner, you don't need to use this switch (the banner is displayed by default).
- To hide the banner, use this exact syntax: `-ShowBanner:$false`.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

### -UserPrincipalName

> Applicable: Exchange Online

The UserPrincipalName parameter specifies the account that you want to use to connect (for example, [email protected]). Using this parameter allows you to skip entering a username in the modern authentication credentials prompt (you're prompted to enter a password).
The UserPrincipalName parameter specifies the account that you want to use to connect (for example, `[email protected]`). Using this parameter allows you to skip entering a username in the modern authentication credentials prompt (you're prompted to enter a password).

If you use the UserPrincipalName parameter, you don't need to use the AzureADAuthorizationEndpointUri parameter for MFA or federated users in environments that normally require it (UserPrincipalName or AzureADAuthorizationEndpointUri is required; OK to use both).

Expand All @@ -455,15 +588,13 @@ Accept wildcard characters: False

> Applicable: Exchange Online

This parameter is available in version 3.2.0 or later of the module.
This parameter is available in module version 3.2.0 or later.

**Note**: Remote PowerShell connections to Security & Compliance are deprecated. For more information, see [Deprecation of Remote PowerShell in Security and Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432).
**Note**: Remote PowerShell connections to Security & Compliance PowerShell are deprecated. For more information, see [Deprecation of Remote PowerShell in Security and Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432).

The UseRPSSession switch allows you to connect to Security & Compliance PowerShell using traditional remote PowerShell access to all cmdlets. You don't need to specify a value with this switch.

This switch requires that Basic authentication is enabled in WinRM on the local computer. For more information, see [Turn on Basic authentication in WinRM](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm).

If you don't use this switch, Basic authentication in WinRM is not required.
If you don't use this switch, REST API mode is used for the connection, so Basic authentication in WinRM isn't required.

```yaml
Type: SwitchParameter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.2.0 or later of the module.
**Note**: This parameter is available in module version 3.2.0 or later.

The ConnectionId parameter specifies the REST API connections to disconnect by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas.

Expand All @@ -131,7 +131,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.2.0 or later of the module.
**Note**: This parameter is available in module version 3.2.0 or later.

The ModulePrefix parameter specifies the REST API connections to disconnect by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ title: Get-ConnectionInformation
# Get-ConnectionInformation

## SYNOPSIS
This cmdlet is available in the Exchange Online PowerShell module v3.0.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
This cmdlet is available in the Exchange Online PowerShell module version 3.0.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).

Use the Get-ConnectionInformation cmdlet to get information about all REST-based connections in the current PowerShell instance with Exchange Online.

Expand Down Expand Up @@ -90,7 +90,7 @@ This example returns a list of active REST-based connections that are using the

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.2.0 or later of the module.
**Note**: This parameter is available in module version 3.2.0 or later.

The ConnectionId parameter filters the connections by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas.

Expand All @@ -112,7 +112,7 @@ Accept wildcard characters: False

> Applicable: Exchange Online

**Note**: This parameter is available in version 3.2.0 or later of the module.
**Note**: This parameter is available in module version 3.2.0 or later.

The ModulePrefix parameter filters the connections by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ title: Get-VivaModuleFeature
# Get-VivaModuleFeature

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).

Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that support feature access controls. This cmdlet provides details about the features, including the feature identifiers and descriptions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ title: Get-VivaModuleFeatureEnablement
# Get-VivaModuleFeatureEnablement

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).

Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. Whether or not the feature is enabled is referred to as the feature's "enablement state". The enablement state returned by this cmdlet is based on the access policies set by the admin.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ title: Get-VivaModuleFeaturePolicy
# Get-VivaModuleFeaturePolicy

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).

Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date. The cmdlet can filter policies based on MemberIds, allowing admins to view policies specific to certain users or groups.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Get-VivaOrgInsightsDelegatedRole
# Get-VivaOrgInsightsDelegatedRole

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.7.1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
This cmdlet is available only in the Exchange Online PowerShell module version 3.7.1 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 delegates of the specified delegator. Delegate accounts can view organizational insights like the specified delegator.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ title: Remove-VivaModuleFeaturePolicy
# Remove-VivaModuleFeaturePolicy

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).

Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module in Viva. Once you delete a policy, the policy is permanently deleted. You can't undo the deletion.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Remove-VivaOrgInsightsDelegatedRole
# Remove-VivaOrgInsightsDelegatedRole

## SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module v3.7.1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
This cmdlet is available only in the Exchange Online PowerShell module version 3.7.1 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 delegate) so they can't view organizational insights like the leader (the delegator).

Expand Down
Loading